BOS API docs.
Guides & references.

From making your first request to setting up permissions, safety rules, and self-hosting.

First visit

Got a URL and key? Send your first request in five minutes.

Open quickstart
Read by role

Start with your role

Select the guides tailored to developers, administrators, or operators.

All guides

Browse the full task directory

Search matches titles, summaries, and section names.

Quickstart

Get an endpoint, key, and model from your administrator, verify model access, and complete your first Chat Completions request.

Read guide

Client integration

Connect to BOS API with cURL, Python, Node.js, or a compatible client.

Read guide

Coding tools

Connect Codex, Claude Code, and compatible clients to authorized models and verify request records.

Read guide

Models & channels

Understand providers, channels, models, and the endpoint your application uses.

Read guide

Teams & keys

Assign keys around people and applications, with clear resource and access boundaries.

Read guide

Admin setup

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

Read guide

Console administration

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

Read guide

Subscription accounts

Connect ChatGPT / Codex, Claude, Gemini CLI / Code Assist, and Antigravity through OAuth, configure models, and grant gateway access.

Read guide

Security controls

Understand credential checks, injection signatures, output code markers, and event investigation, and verify matches and actions.

Read guide

Usage & quotas

Distinguish tokens, calculated cost, cumulative quotas, and request frequency.

Read guide

Requests & debugging

Start with a request ID, then check configuration, access, quotas, and upstream responses.

Read guide

One-command install

Install BOS API on Linux or macOS. Start an existing checkout without Nginx and optionally access it by IP and port.

Read guide

Docker Compose

Build BOS API from source and manage private configuration, the app, MySQL, Redis, HTTPS, and routine operations.

Read guide

Local development

Run the Go backend and Vite frontend locally with dedicated MySQL and Redis services, then verify login, debugging, and builds.

Read guide

Host monitoring

Install the optional Linux host collector, verify freshness, and troubleshoot the status page.

Read guide

Images and updates

Publish a committed image, install the updater, check for updates, and recover with schema compatibility in mind.

Read guide

Upgrades & backups

Prepare a recoverable upgrade workflow around configuration, database, Redis, and gateway data.

Read guide

Deployment troubleshooting

Diagnose Docker, Compose, container health, reverse proxying, and business requests layer by layer.

Read guide

Versions & scope

Check that documentation, deployment versions, and validation results align.

Read guide

Examples use placeholder endpoints, keys, and models. Match actual capabilities to your deployed version.

Read about 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