First-time administration

Start with the first sign-in and complete the minimum channel, model, access, and gateway-key configuration.

Administrator task guideUpdated Oct 28, 2026

Step 1: sign in and secure the account

Sign in with the administrator account created during installation. Complete required two-factor authentication immediately, then confirm the account role and organization scope. Do not share administrator accounts.

Step 2: connect your upstream service

Choose the channel credential mode: enter the upstream endpoint, protocol, and credential for an API key / upstream proxy, or select a platform for Official subscription (OAuth), sign in, paste the authorization result, and save. New channels default to subscription sign-in; models can be configured after saving. The upstream endpoint is separate from the public BOS API endpoint.

  • Validate connectivity with a test account or restricted credential first.
  • Review service terms, regional restrictions, and commercial-use requirements.
  • Do not expose upstream keys in screenshots, tickets, or shared logs.

Step 3: configure models and protocols

Use the actual upstream model ID and specify whether it supports Chat Completions, Responses, or Messages. Verify with a test call; do not infer capabilities from the model name alone.

Step 4: create access and a gateway key

Create gateway keys by application, environment, or team purpose, with model access, quotas, and rate boundaries. Deliver each key only to its intended user together with the Base URL, model ID, and supported protocol.

Step 5: hand off and verify the first request

Have the developer follow the quickstart to list models and make the first request. Use request records to verify the request ID, model, status, and usage.

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