接入文档 - CC Switch

三步接入

登录控制台

前往 CC Switch 控制台，由管理员分配或创建你的专属 API Key。

获取 API Key

一个人或一个项目建议使用独立 Key，便于停用、统计和排查问题。

改一行代码

将 BASE_URL 改为 https://api.ccswitch.cc/v1，原 SDK 结构无需重写。

Node.js 环境安装

Codex、Gemini CLI、OpenClaw 和 Hermes 这类工具通常依赖 Node.js。开始配置前，先确认本机可用版本。

检查环境 Node.js

node --version
npm --version

macOS

brew install node

Windows

winget install OpenJS.NodeJS.LTS

Linux / WSL

curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

配置脚本

脚本会在本机提示输入 CC Switch API Key，并生成对应工具的 CC Switch 配置。复制命令本身不包含密钥。

Codex Windows

写入 ~/.codex/config.toml，Base URL 为 https://api.ccswitch.cc/v1。

irm https://ccswitch.cc/install/codex.ps1 | iex

Codex macOS / Linux / WSL

检测 Node.js 和 Codex CLI，缺失时会提示安装。

curl -fsSL https://ccswitch.cc/install/codex.sh | bash

OpenClaw

按提示选择 Claude 或 OpenAI/Codex 通道，并生成 CC Switch 配置参考。

curl -fsSL https://ccswitch.cc/install/openclaw.sh | bash

Hermes

按提示选择通道，生成可复用的 CC Switch 配置文件。

curl -fsSL https://ccswitch.cc/install/hermes.sh | bash

Python 接入示例

Python 脚本可直接用于服务端、本地脚本或最小化连通性测试。真实聊天请求会消耗上游额度。

python OpenAI SDK

from openai import OpenAI

# 只需改这里
client = OpenAI(
    api_key="sk-your-ccswitch-key",
    base_url="https://api.ccswitch.cc/v1",
)

response = client.chat.completions.create(
    model="gpt-5.3-codex",
    messages=[{"role": "user", "content": "Hello!"}],
)

print(response.choices[0].message.content)

命令行示例 curl

用于脚本、服务器或快速排错。真实聊天请求会消耗上游额度。

curl chat.completions

curl https://api.ccswitch.cc/v1/chat/completions \
  -H "Authorization: Bearer sk-your-ccswitch-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.3-codex",
    "messages": [
      { "role": "user", "content": "Hello!" }
    ]
  }'

Node.js 接入示例

使用官方 OpenAI SDK 时，字段名是 baseURL。

node.js OpenAI SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-your-ccswitch-key",
  baseURL: "https://api.ccswitch.cc/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.3-codex",
  messages: [{ role: "user", content: "Hello!" }],
});

console.log(response.choices[0].message.content);

支持的工具集成

OpenClaw

Claude / Anthropic 通道使用 https://api.ccswitch.cc，OpenAI / Codex 通道使用 https://api.ccswitch.cc/v1。

Claude Code

如管理员已开通 Claude 或 Antigravity 上游，按控制台提供的配置接入。

OpenAI Codex

支持自定义入口的客户端更换 BASE_URL 即可。

Gemini CLI

设置 GOOGLE_GEMINI_BASE_URL=https://api.ccswitch.cc、GEMINI_API_KEY 和 GEMINI_MODEL。

Cursor

在设置中填写自定义 API 地址、CC Switch Key 和可用模型名。

Hermes

使用配置脚本生成 CC Switch 地址、Key 和模型名，再按 Hermes 当前版本的 provider 设置填入。

Gemini CLI 环境变量

安装 Gemini CLI 后，将环境变量指向 CC Switch。模型名以你的 Key 可见模型为准。

macOS / Linux / WSL Gemini CLI

export GOOGLE_GEMINI_BASE_URL="https://api.ccswitch.cc"
export GEMINI_API_KEY="sk-your-ccswitch-key"
export GEMINI_MODEL="gemini-3-pro-preview"

gemini -p "你好"

Windows PowerShell Gemini CLI

$env:GOOGLE_GEMINI_BASE_URL = "https://api.ccswitch.cc"
$env:GEMINI_API_KEY = "sk-your-ccswitch-key"
$env:GEMINI_MODEL = "gemini-3-pro-preview"

gemini -p "你好"

Codex 配置片段

一键脚本会写入同等配置。手动配置时保留你自己的 API Key 和可用模型名。

~/.codex/config.toml Codex

model_provider = "ccswitch"
model = "gpt-5.3-codex"
preferred_auth_method = "apikey"

[model_providers.ccswitch]
name = "CC Switch"
base_url = "https://api.ccswitch.cc/v1"
wire_api = "responses"
experimental_bearer_token = "sk-your-ccswitch-key"
requires_openai_auth = true

接入注意

Base URL

OpenAI-compatible 客户端填写 https://api.ccswitch.cc/v1。后台入口 https://ccswitch.cc 不作为 API Base URL。

API Key

使用 CC Switch 控制台生成的用户令牌，不要填写 OpenAI、Claude、Gemini 或其他上游平台密钥。

模型名

优先使用 GET /v1/models 返回的真实模型名。不同 Key 可见模型可能不同。