Sub2API AI API 网关使用手册
api.example.com 打开控制台
FIELD GUIDE2026 EDITION

从一枚密钥,到第一个成功响应

把复杂的 API 接入,
压缩成一条清晰路径。

这是一份面向实际使用者的完整手册。跟着页面完成权限准备、密钥创建与客户端配置, 不需要预先理解网关、协议或环境变量。

5 min完成首次调用
4+主流客户端
3兼容协议
REQUEST ROUTE READY
K
01API Key
S
02Sub2API
M
03Model
$ curl {{API_V1}}/models
认证调度计费转发
先读这里

模型、分组与套餐由站点管理员动态配置。教程不写死模型清单,请以控制台实时显示为准。

01

QUICK START

五分钟快速开始

第一次使用只需要完成四件事。每完成一步,再进入下一步。

01

注册并登录

进入控制台创建账号。若站点开启了邮箱验证、OAuth 或两步验证,请按页面提示完成。

02

获得权限

购买套餐、充值余额或使用兑换码。你能使用哪些分组和模型,取决于当前账号权益。

03

创建密钥

前往「API 密钥」,选择正确分组并创建 Key。密钥是客户端访问平台的唯一凭证。

04

复制配置并测试

点击密钥右侧的「使用」,选择你的客户端和系统,复制平台生成的配置。

最稳妥的原则

教程里的手工配置用于理解和排错。实际接入时,优先复制控制台「使用密钥」弹窗中的内容,它会跟随站点配置更新。

02

ACCESS

先获得可用的分组权限

Key 本身不创造额度;它只使用账号已经拥有的余额、订阅与分组权限。

任选一种方式开始

CHECK BEFORE NEXT

进入密钥页前,确认三项

  • 1账号状态为正常
  • 2余额或订阅仍在有效期
  • 3至少拥有一个可选分组

如果创建 Key 时没有任何分组,请先检查权益,或联系站点管理员为账号授权。

03

CREDENTIALS

创建第一枚 API 密钥

给不同设备和用途创建不同 Key,后续查看用量、撤销权限和定位问题都会更清楚。

  1. 1

    打开「API 密钥」并点击「创建密钥」

    建议把名称写成具体用途,例如 Windows-CodexMac-ClaudeDemo-App

  2. 2

    选择与你要使用的客户端相匹配的分组

    分组决定可用协议、模型和计费规则。Codex 通常选择 OpenAI 分组;Claude Code 选择 Anthropic 或支持消息转发的分组;Gemini CLI 选择 Gemini 分组。

  3. 3

    按需设置配额、有效期与速率限制

    个人主力 Key 可以保留默认值;临时分享或测试 Key 建议设置较小配额和明确过期时间。可见字段会随站点策略变化。

  4. 4

    创建后立即完成一次客户端配置

    点击该 Key 右侧的「使用」,再选择客户端与操作系统。不要把真实 Key 发到聊天群、截图或公开代码仓库。

字段用途建议
名称区分设备与项目写清用途
分组决定协议、模型和费率必须正确
计费来源选择余额或订阅按权益选择
配额 / 有效期控制最大消耗与存活时间临时 Key 必设
04

RECOMMENDED

CC-Switch 一键导入

如果密钥行显示「导入到 CCS」,这是桌面客户端用户最省事的接入方式。

!
先避开三个高频问题

必须安装 CC-Switch 桌面客户端;使用 Chrome、Edge、Safari 或 Firefox 打开控制台;导入后完整退出并重启目标客户端。

01

安装并启动 CC-Switch

确认桌面窗口或系统托盘图标已经出现,并保持程序在后台运行。

02

在系统浏览器打开密钥页

App 内置浏览器可能阻止 ccs:// 本地唤醒链接,请不要从微信、QQ 等内置浏览器操作。

03

点击「导入到 CCS」

如果是多协议分组,按弹窗选择 Claude 或 Gemini 客户端;浏览器询问是否打开外部应用时选择允许。

04

重启 Codex、Claude Code 或编辑器

旧进程可能缓存原来的环境变量与配置。只关闭聊天窗口或刷新插件通常不够。

05

CLIENT / OPENAI

Codex 手工配置

优先从「使用密钥 → Codex CLI」复制完整文件。下面展示配置的关键结构,便于你核对与排错。

文件 1 · ~/.codex/config.toml

TOML
model_provider = "Sub2API"
model = "{{MODEL}}"
review_model = "{{MODEL}}"
model_reasoning_effort = "high"
disable_response_storage = true

[model_providers.Sub2API]
name = "Sub2API"
base_url = "{{API_V1}}"
wire_api = "responses"
requires_openai_auth = true

文件 2 · ~/.codex/auth.json

JSON
{
  "OPENAI_API_KEY": "sk-替换成你的真实密钥"
}
i
配置不生效时

完整退出 Codex 或承载插件的编辑器再重新打开。若控制台提供 WebSocket 配置,请直接使用平台生成的版本,不要只手动加一个开关。

06

CLIENT / ANTHROPIC

Claude Code

使用 Anthropic 分组,或管理员已开启 Messages 转发能力的 OpenAI 分组。

SHELL
export ANTHROPIC_BASE_URL="{{API_ROOT}}"
export ANTHROPIC_AUTH_TOKEN="sk-替换成你的真实密钥"
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
需要长期生效?使用 settings.json+

把以下内容保存到 ~/.claude/settings.json;Windows 通常位于 %USERPROFILE%\.claude\settings.json

JSON
{
  "env": {
    "ANTHROPIC_BASE_URL": "{{API_ROOT}}",
    "ANTHROPIC_AUTH_TOKEN": "sk-替换成你的真实密钥",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
07

CLIENT / GEMINI

Gemini CLI

Gemini CLI 通过环境变量读取网关地址、密钥和默认模型。实际模型名请从控制台或模型列表获取。

SHELL
export GOOGLE_GEMINI_BASE_URL="{{API_ROOT}}"
export GEMINI_API_KEY="sk-替换成你的真实密钥"
export GEMINI_MODEL="{{GEMINI_MODEL}}"

NOTE 如果密钥属于 Antigravity 分组,端点和模型映射会不同,请直接复制控制台「使用密钥」弹窗生成的配置。

08

CLIENT / MULTI-PROTOCOL

OpenCode

OpenCode 配置会随分组平台生成不同的 provider、npm 适配器与模型清单,因此推荐整段复制平台输出。

KEYUSEOPENCODEPASTE

控制台生成法

  1. 进入 API 密钥 页面。
  2. 点击目标 Key 右侧的「使用」。
  3. 在客户端标签中选择「OpenCode」。
  4. 复制完整 opencode.json,替换本地对应配置。
i
为什么不推荐手写?

OpenAI、Anthropic、Gemini 与 Antigravity 使用不同 provider,模型能力和上下文限制也由站点动态调整。平台输出比固定教程更可靠。

09

DEVELOPMENT

SDK 与 cURL

先请求模型列表,再把返回的模型 ID 填入示例。不要把真实 Key 直接写进将要提交的源码。

步骤 1 · 查看当前 Key 可用的模型

CURL
curl "{{API_V1}}/models" \
  -H "Authorization: Bearer sk-替换成你的真实密钥"

步骤 2 · 发起 Responses API 请求

CURL
curl "{{API_V1}}/responses" \
  -H "Authorization: Bearer sk-替换成你的真实密钥" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "{{MODEL}}",
    "input": "用一句话介绍 API 网关"
  }'
10

OBSERVABILITY

用量与渠道状态

从请求明细确认消耗与错误,再从分组状态、延迟、可用率和模型评分判断当前更适合使用哪个模型。

READ STATUS IN ORDER

先看分组,再看模型

打开渠道状态 ↗
GROUP HEALTH

分组状态

分组卡片会显示主模型、当前状态、对话延迟与端点 PING;7 / 15 / 30 天可用率更适合判断长期稳定性。

  • 先确认自己 Key 所属分组
  • 再展开查看附加模型状态与延迟
CODEX RADARSCORE

模型评分

评分来自基准任务表现,会同时显示通过任务数与近期趋势,可用于快速比较模型的任务能力。

  • 评分不是实时可用率,也不代表价格
  • 选型时要与分组状态、延迟和可用率一起看
11

SERVICE DESK

反馈问题,也别错过重要消息

服务中心把问题工单和站点公告放在同一个入口:需要帮助时提交问题,平时也可查看维护安排与活动信息。

i
提交前先保留现场信息

建议复制错误正文并记录发生时间;如果需要截图,请先遮住 API Key、余额和其他敏感信息。

12

IMAGE PLAYGROUND

配置生图工作台

生图工作台支持文本生图、参考图和遮罩编辑。第一次使用时,先准备一枚可访问生图模型的 API Key。

01
打开生图入口

从控制台侧栏进入「生图」,再打开「设置 → API 配置」。

02
选择兼容接口

服务商选择「OpenAI 兼容接口」,按右侧字段填入连接信息。

03
保存并生成

选择已配置的模型,输入提示词;需要时再上传参考图或遮罩。

API PROFILEOpenAI 兼容接口
API URL{{API_V1}}填写平台提供的 API 地址
API Keysk-••••••••••••使用具备对应模型权限的 Key
Images APIgpt-image-2默认图片模型,可按站点实际模型调整
Responses APIgpt-5.5需支持 image_generation 能力
文本生图参考图遮罩编辑尺寸与质量格式选择多图生成历史记录
!
配置项可能由站点预先锁定

如果 API URL 已由站点统一配置,你可能只需填写 Key 或选择模型。生图历史保存在当前浏览器本地,换浏览器或清理网站数据前请先导出备份。

13

TROUBLESHOOTING

按状态码快速定位

先去「用量 → 错误请求」找到对应记录,再按照下面的顺序检查。

401
认证失败

Key 缺失、复制不完整、已禁用或已过期。确认请求头使用 Authorization: Bearer <Key>

403
权限或策略拒绝

检查 Key 的分组、IP 限制、内容策略与账号权限;确认没有把其他平台的 Key 混用。

404
端点或模型不存在

OpenAI SDK 一般使用 {{API_V1}};Claude Code 的 Base URL 一般使用 {{API_ROOT}}。再确认模型 ID 来自当前 Key 的模型列表。

429
触发限流或额度不足

检查 Key 配额、订阅/余额、RPM/并发限制。降低并发或等待限流窗口恢复后重试。

5xx
服务或上游暂时异常

查看渠道状态和错误详情;短暂故障可指数退避重试,持续失败时把请求时间与错误记录 ID 提交到服务中心。

排查顺序
  1. Key 状态
  2. 分组与模型
  3. Base URL
  4. 额度与限流
  5. 渠道状态
14

SECURITY

把 API Key 当作密码

拥有 Key 的人可以消耗对应额度。即使平台支持配额和限流,也不应依赖它们替代密钥保护。

DO

建议这样做

  • 使用环境变量或密钥管理服务
  • 为设备和项目创建独立 Key
  • 给临时 Key 设置配额与过期时间
  • 定期查看异常用量并轮换密钥
DON'T

不要这样做

  • 提交到 Git、镜像或公开配置文件
  • 把完整 Key 放进截图和工单标题
  • 多人长期共用同一枚无限额 Key
  • 泄露后仅停止客户端而不撤销 Key
×
怀疑泄露时立即撤销

在 API 密钥页禁用或删除旧 Key,再创建一枚新 Key 并更新所有客户端。不要等待异常消费出现后再处理。

READY TO ROUTE

现在,创建你的第一枚 Key。

从控制台生成配置,完成一次模型列表请求,再开始正式使用。

已复制到剪贴板