sub2api // 接入文档
// AI API GATEWAY · 接入手册

把你的客户端
接入 sub2api

一个网关,兼容 Anthropic / OpenAI / Gemini 协议。下面是 Claude Code、Codex、cc-switch 等常用客户端的配置教程 —— 复制、粘贴、跑起来。

Anthropic Messages OpenAI Responses Chat Completions Gemini v1beta

0开始之前 · 你需要两样东西

所有客户端的接入本质是同一件事:告诉它 网关地址API Key

你的两个凭据
# 1) 网关地址 Base URL —— 换成你自己的域名/IP
BASE_URL=https://your-domain.com        # 生产:域名 + HTTPS(推荐)
BASE_URL=http://47.83.128.6:8080        # 或:直接 IP:端口

# 2) API Key —— 登录后台 → API 令牌 → 新建,形如 sk-xxxx
API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
在哪拿 Key 浏览器打开 BASE_URL → 用管理员账号登录 → 进入「API 令牌 / API Keys」页 → 新建一个令牌 → 复制 sk- 开头的字符串。给不同用途建不同 Key,方便随时吊销。
关于地址格式 不同客户端对 Base URL 的要求不同:Claude Code 用不带 /v1 的根地址;Codex / OpenAI 类用带 /v1 的地址。每篇教程里都写清楚了,照抄即可。

1选择你的客户端

2接口速查表

网关暴露的主要端点(相对 BASE_URL)。鉴权支持三种 Header:Authorization: Bearer sk-...x-api-key: sk-...、Gemini 用 x-goog-api-key

协议 / 客户端方法端点说明
Claude CodePOST/v1/messagesAnthropic 消息接口
CodexPOST/v1/responsesOpenAI Responses API
Codex(直连别名)POST/backend-api/codex/responsesCodex 专用路径
OpenAI 兼容POST/v1/chat/completionsChat Completions
EmbeddingsPOST/v1/embeddings向量(仅 OpenAI 平台分组)
图像POST/v1/images/generations文生图
GeminiPOST/v1beta/models/*Gemini 原生兼容
模型列表GET/v1/models可用模型
健康检查GET/health存活探针(无需鉴权)

3一条命令验活

配任何客户端前,先用 curl 确认网关和 Key 是对的:

bash — 冒烟测试 复制
# 健康检查(无需 Key)
$ curl $BASE_URL/health
{"status":"ok"}

# 带 Key 拉模型列表
$ curl $BASE_URL/v1/models \
     -H "Authorization: Bearer $API_KEY"
{"object":"list","data":[{"id":"claude-...","object":"model"}, ...]}
读结果 /health 返回 ok = 网关活着;/v1/models 返回模型列表 = Key 有效且分组已放开模型。若返回 401,检查 Key;返回连接拒绝,检查地址/端口/防火墙。
下一篇 →Claude Code 接入