接入编程工具

将 Codex、Claude Code 和兼容客户端连接到授权模型,并核对调用记录。

开发者接入指南更新于 2026-10-28

准备地址、Key 和模型

向管理员获取网关地址、完整 BOS API Key 和准确模型 ID。确认模型支持客户端所需的协议、流式输出和工具调用。示例地址和模型均需替换;不要将真实 Key 提交到仓库。

Codex Desktop / CLI

使用支持 Responses 的已授权模型。上游可使用 ChatGPT / Codex 官方订阅;工具与流式调用使用 Responses,不能沿用其仅支持普通非流式对话的 Chat / Messages 兼容路径。将以下配置合并到用户级 ~/.codex/config.toml;model 和 model_provider 位于顶层,保留已有设置,避免重复 TOML 表。先在启动客户端的环境中设置 BOS_GATEWAY_KEY,再启动或重启客户端。

用户级 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

管理员需要配置 Anthropic API Key 或 Claude 官方订阅(OAuth)上游,API 格式为 anthropic_messages,并授权所选模型。下面的地址是网关根地址,不包含 /v1;变量只作用于当前终端及其子进程。

macOS、Linux 或 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
  • 在项目目录启动后用 /status 检查配置;401 时检查已有 Anthropic 凭据是否冲突,辅助模型失败时核对其授权。
  • 恢复原有环境时关闭该终端并新开一个;不要删除整份设置文件。

其他编程客户端

  • Cline / Roo Code:在 VS Code 扩展中选择 OpenAI Compatible,Base URL 通常包含一次 /v1,填写完整 Key 和模型 ID。Roo 的工具操作需要模型具备实际原生工具调用能力。
  • OpenCode:在用户级配置中添加 OpenAI 兼容提供商,使用环境变量引用 Key,并在 /models 中选择已配置模型。
  • Cursor:仅在当前版本提供 Override OpenAI Base URL 时使用,先配置网关地址再填 Key;其后端无法访问只对本机开放的网关,自定义 Key 也不覆盖所有托管功能。
  • Claude Desktop、OpenClaw 和其他工具的版本化步骤可在自己的 BOS API 实例内打开编程助手文档查看;实例地址和界面由管理员提供。

验证请求与排错

  • 新建会话,请助手只回复 BOS_OK;在 BOS API 的用量明细或错误日志按 Key、时间和模型核对,客户端显示连接成功本身不能证明请求经过网关。
  • 在小型项目中单独验证读取文件、流式输出和工具调用,保留客户端审批。文本成功但工具失败时,核对模型能力及错误 Request ID。

按部署版本核对具体能力与操作。 查看文档适用范围

BOS API · TYPEX

销售咨询暂不可用

暂时无法初始化销售接待,请稍后重试。你仍可查看文档并免费自托管。

查看文档免费自托管