Connect coding tools

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

Developer integration guideUpdated Oct 28, 2026

Prepare an endpoint, key, and model

Obtain the gateway address, full BOS API key, and exact model ID from your administrator. Confirm the model supports the required protocol, streaming, and tool calls. Replace example values and never commit real keys.

Codex Desktop / CLI

Use an authorized model supporting Responses. A ChatGPT / Codex official subscription can be used upstream; tools and streaming require Responses rather than its plain non-streaming Chat / Messages compatibility path. Merge the following into the user-level ~/.codex/config.toml; model and model_provider belong at the top level. Preserve existing settings and avoid duplicate TOML tables. Set BOS_GATEWAY_KEY in the environment that launches the client, then start or restart it.

User-level config.toml
model = "YOUR_MODEL_ID"
model_provider = "bosapi"

[model_providers.bosapi]
name = "BOS API"
base_url = "https://bosapi.example.com/v1"
env_key = "BOS_GATEWAY_KEY"
wire_api = "responses"
requires_openai_auth = false

Claude Code

An administrator must configure an Anthropic API-key or Claude official subscription (OAuth) upstream with API format anthropic_messages and authorize the model. The address below is the gateway root without /v1; variables apply only to this terminal and child processes.

macOS, Linux, or WSL
export ANTHROPIC_BASE_URL="https://bosapi.example.com"
export ANTHROPIC_AUTH_TOKEN="YOUR_BOS_API_KEY"
export ANTHROPIC_MODEL="YOUR_MODEL_ID"
claude
Windows PowerShell
$env:ANTHROPIC_BASE_URL="https://bosapi.example.com"
$env:ANTHROPIC_AUTH_TOKEN="YOUR_BOS_API_KEY"
$env:ANTHROPIC_MODEL="YOUR_MODEL_ID"
claude
  • Launch in the project directory and use /status to inspect configuration. For 401 errors, check conflicting Anthropic credentials; if helper models fail, check their authorization.
  • Close the terminal and open a new one to restore the prior environment; do not delete the entire settings file.

Other coding clients

  • Cline / Roo Code: select OpenAI Compatible in the VS Code extension, enter a Base URL usually containing /v1 once, the full key, and model ID. Roo tool operations require actual native tool-call support.
  • OpenCode: add an OpenAI-compatible provider to the user configuration, reference the key through an environment variable, and select the configured model in /models.
  • Cursor: use this only when the installed version offers Override OpenAI Base URL. Configure the gateway address before entering the key. Cursor’s backend cannot reach a localhost-only gateway, and custom keys do not cover all hosted features.
  • For version-specific Claude Desktop, OpenClaw, and other instructions, open the coding-agent documentation inside your own BOS API instance; ask your administrator for the instance address.

Verify and troubleshoot

  • Start a new conversation and ask for only BOS_OK. Match the key, time, and model in BOS API usage details or error logs; a client’s connected label alone does not prove the request went through the gateway.
  • In a small project, verify file reading, streaming, and tool calls separately while keeping client approvals enabled. If text works but tools fail, check model capabilities and the error Request ID.

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