CDAPI DOCS

CLIENT INTEGRATIONS

把 CDAPI 接入你正在用的工具

先判断客户端使用 OpenAI 兼容协议还是 Anthropic Messages 协议,再填写 Key、Base URL 和实时模型 ID。

选择客户端

先确定端点规则

客户端协议 填写的 Base URL 客户端最终请求
OpenAI Compatible https://ai.bycomet.cc/v1 /v1/chat/completions 或 /v1/responses
Anthropic / Claude https://ai.bycomet.cc /v1/messages
长任务或生成任务 https://api-direct.ai.bycomet.cc/v1 对应的 OpenAI 兼容资源路径
同一个 Key 可以用于多种协议

差异在 URL 拼接方式。遇到 404 时先检查客户端是否已经自动追加 /v1 或完整资源路径。

选择客户端

RECOMMENDED IMPORT

CC Switch 一键导入

适合已经支持 CCS 导入的工具,包括 Claude Code、Cursor、OpenClaw 与 Hermes。控制台会把端点、Key 和模型选择交给 CC Switch 写入,减少手工录入错误。

COMPATIBLE ENDPOINT
由导入配置决定
REQUIRED INPUT
令牌、应用类型、模型
SUCCESS SIGNAL
导入成功并完成 200 请求
  1. 从 CC Switch Releases 安装最新版。
  2. 进入 令牌管理,在目标令牌上选择“CCS 导入”。
  3. 选择应用类型和模型。模型 ID 以模型广场当前展示为准。
  4. 允许浏览器打开 CC Switch,核对脱敏 Key 与端点后确认导入。
测试与成功信号

在目标工具发送“只回复 ok”。收到响应后,控制台使用日志应出现状态码 200 的同一模型请求。

导入按钮无反应时,检查是否安装了完整版本,并允许浏览器打开 ccswitch:// 协议。仍失败时改用对应客户端的手动配置。

OPENAI RESPONSES

Codex CLI

在用户级 ~/.codex/config.toml 中定义 CDAPI provider。Provider 与凭据重定向配置不应放进项目级 .codex/config.toml。

BASE URL
https://ai.bycomet.cc/v1
WIRE API
responses
KEY VARIABLE
CDAPI_API_KEY
~/.codex/config.toml
model = "YOUR_MODEL_ID"
model_provider = "ccapi"

[model_providers.ccapi]
name = "CDAPI"
base_url = "https://ai.bycomet.cc/v1"
env_key = "CDAPI_API_KEY"
wire_api = "responses"
Shell test
export CDAPI_API_KEY="sk-你的令牌"
codex exec "只回复 ok"
成功信号

Codex 返回结果,使用日志出现 /v1/responses 请求且状态码为 200。

若出现认证、404 或模型错误,分别查看 401、404、模型不存在。配置键可对照 Codex 官方配置参考。

ANTHROPIC MESSAGES

Claude Code

CDAPI 使用 Bearer 认证,因此手动接入时使用 ANTHROPIC_AUTH_TOKEN,Base URL 不带 /v1。

BASE URL
https://ai.bycomet.cc
CREDENTIAL
ANTHROPIC_AUTH_TOKEN
MODEL
模型广场完整 ID
Shell
export ANTHROPIC_BASE_URL="https://ai.bycomet.cc"
export ANTHROPIC_AUTH_TOKEN="sk-你的令牌"
export ANTHROPIC_MODEL="YOUR_MODEL_ID"

claude -p "只回复 ok"

需要持久化时,将相同变量放入 Claude Code 用户设置的 env 对象。不要把 /v1/messages 写进 ANTHROPIC_BASE_URL。

settings.json
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://ai.bycomet.cc",
    "ANTHROPIC_AUTH_TOKEN": "sk-你的令牌",
    "ANTHROPIC_MODEL": "YOUR_MODEL_ID"
  }
}
成功信号

命令返回 ok,使用日志出现 /v1/messages 请求且状态码为 200。

若请求仍发往官方地址,先检查当前 shell 的变量,再完全退出并重启 Claude Code。继续查看 401、404 或 模型不存在。变量语义可对照 Claude Code Gateway 文档。

OPENAI COMPATIBLE

Cursor

在 Cursor Settings 的 Models 区域配置 OpenAI API Key,并启用 OpenAI Base URL 覆盖。不同版本的字段位置可能略有差异。

PROVIDER
OpenAI
BASE URL
https://ai.bycomet.cc/v1
MODEL
手动添加完整 ID
Cursor fields
Provider: OpenAI
API Key: sk-你的令牌
Override OpenAI Base URL: https://ai.bycomet.cc/v1
Model: YOUR_MODEL_ID
  1. 打开 Settings,进入 Models。
  2. 填入 Key,并将 OpenAI Base URL 覆盖为 https://ai.bycomet.cc/v1。
  3. 添加模型广场显示的完整模型 ID,并在 Chat 中选中。
  4. 发送“只回复 ok”。Composer 或长任务超时时,可改用 https://api-direct.ai.bycomet.cc/v1。
成功信号

Chat 返回结果,使用日志显示对应模型和 200。Cursor 自带补全能力不一定走自定义 API,验收请以 Chat 请求为准。

验证 Key 失败时先看 401;保存后立即 404 时检查是否把完整 /chat/completions 路径误填进 Base URL。

DESKTOP & SELF-HOSTED

Cherry Studio、Chatbox 与其他客户端

支持 OpenAI Compatible 或自定义 OpenAI Provider 的客户端通常使用同一组字段。

客户端 提供商 Base URL 模型
Cherry Studio OpenAI https://ai.bycomet.cc/v1 手动添加完整 ID
Chatbox OpenAI API https://ai.bycomet.cc/v1 选择或手动输入
Open WebUI OpenAI Connection https://ai.bycomet.cc/v1 从连接读取
LobeChat / NextChat OpenAI Compatible https://ai.bycomet.cc/v1 手动输入完整 ID
通用字段
API Key: sk-你的令牌
Base URL: https://ai.bycomet.cc/v1
Model: YOUR_MODEL_ID
测试与成功信号

新建空对话并发送“只回复 ok”。响应出现后,到使用日志确认状态码、模型和扣费记录。

客户端把 /v1 自动追加两次时会得到 404。若工具明确要求“Host”而不是“Base URL”,查看它最终请求的 URL,再按 404 排查表修正。