Console administration

Manage organizations, channels, keys, routing, usage, and security step by step.

Administrator task guideUpdated Oct 28, 2026

Roles and prerequisites

Use a super administrator for platform configuration. A super administrator does not belong to an organization; an organization administrator belongs to one organization and can manage its keys and private channels, while assigned public channels are read-only. There is no default organization; console accounts and gateway keys are separate credentials.

Configure channels and models

  • Prepare an upstream service or an eligible official subscription account. In Channels and models, create a channel using an API key, upstream proxy, or Official subscription (OAuth); subscription mode fills the official endpoint and protocol automatically.
  • Scan for models, open the channel model list, and verify model IDs, enabled state, and prices. Discovery and capability metadata do not prove a request succeeds.
  • Official subscriptions support ChatGPT / Codex, Claude, Gemini CLI / Code Assist, and Antigravity. Sign in, paste the authorization result, and save before configuring models. Confirm the required protocol, streaming, and tool support with small requests.

Create an organization and assign channels

  • A super administrator creates an organization in Organization management, names it, sets it active, and selects allowed channels and models.
  • Open channel bindings, explicitly assign public channels, and enable the bindings. An empty public assignment does not grant all public channels. An empty model allowlist still requires other access conditions to be satisfied.
  • When a console account is needed, create an org_admin for that organization in Administrator configuration. Creating an organization does not create an administrator or key.

Issue and verify a key

  • Create a key in API keys, select its organization, and set its name, budgets, and IP allowlist as needed. A key belongs to an organization, not a person.
  • Empty channel and model restrictions inherit organization and channel policy. Select all saves an explicit current list; future models are not automatically included. An empty budget is unlimited at that layer; zero is a zero budget.
  • Securely save the full key when it is issued and provide the gateway address and authorized models to the user. A super administrator sets the address under Settings → API address; client import is unavailable when it is empty.
  • List models and make a request with the key, then match usage or error records by time and model. Verify full-key viewing, MFA, and client import workflows against the deployed version.

Routing, rate limits, and budgets

  • After direct model calls work, a super administrator can configure a public model name, protocol, and channels and models for short and long requests in Smart routing. Test both paths; routing cannot bypass organization or key permissions.
  • Set global, organization, or key QPS and rolling token windows in Rate limits and quotas. Zero QPS means no limit at that layer, while other limits still apply; rolling windows differ from calendar budgets.

Usage, security, and notifications

  • Inspect usage, request traces, and errors by key, model, time, and Request ID. Missing metrics do not mean zero traffic.
  • Test security rules with observe and harmless examples first; enable block as needed after checking matches and false positives. Review rules, actions, and outcomes in the security audit.
  • Message OTP configuration and security-event webhooks are separate settings. Verify administrator enrollment, verification codes, and MFA end to end in your deployment.

Installation telemetry

Installation telemetry is disabled by default and can be enabled or disabled by a super administrator under System settings → Installation telemetry. Before enabling, review the displayed destination domain, fields, frequency, and retention information. The destination is fixed by build configuration and cannot be changed in the console.

Reports contain minimal fields such as installation identity, version, operating system and architecture, plus date and timezone for daily reports; they exclude request content, keys, and business usage. Disabling telemetry does not disable local usage or gateway functions, and cannot retract data already delivered to the receiver.

Match capabilities and procedures to your deployment version. Read the documentation scope

BOS API · TYPEX

Sales consultation is unavailable

Sales reception could not be initialized. Please try again later. Documentation and free self-hosting remain available.

Read the docsSelf-host for free