API 参考

鉴权

使用 API Key 识别账户,并通过对应分组调用模型。

调用 AIGoCode API 时,将 API Key 放入请求头。平台根据 Key 识别账户与接入分组,按照该分组的模型范围和价格处理请求。

三种鉴权方式

根据调用的接口协议,使用对应的请求头:

接口协议请求头写法模型示例
OpenAI 兼容Authorization: Bearer YOUR_API_KEYGPT、Grok
Anthropic Messagesx-api-key: YOUR_API_KEYClaude、Grok、GLM、Kimi、DeepSeek
Gemini 原生接口x-goog-api-key: YOUR_API_KEYGemini

协议表示接口格式,与模型厂商分别对应。 Grok 支持 OpenAI 和 Anthropic 双协议;GLM、Kimi、DeepSeek 等模型通过 Anthropic 协议接入。

所有支持 OpenAI 协议的模型,都同时支持 Responses 和 Chat Completions,两种接口使用相同的 Bearer 认证方式。

API Key 与接入分组

每把 API Key 绑定一个分组。 分组决定可调用的模型、支持的协议、适用工具和计费价格。

创建 Key 时,在 模型广场 查看分组的「接入协议」「适用工具」和模型列表,选择与你的调用方式匹配的分组:

  • 直接调用 API:选择支持外接调用的分组,按接口协议填写认证头。
  • 配置编程工具:按照对应教程选择分组,填写工具需要的 Key 和服务地址。
  • 使用 Grok 双协议:根据客户端采用的 OpenAI 或 Anthropic 格式,使用对应的认证头。

你可以为不同工具或项目创建独立 Key。所有 Key 共用账户的套餐额度和灵活额度,调用按各自绑定分组的价格计费。

设置环境变量

以下使用 AIGOCODE_API_KEY 保存 API 示例所需的 Key。选择与你当前终端对应的命令:

macOS / Linux

export AIGOCODE_API_KEY="填写对应分组的 API Key"

Windows PowerShell

$env:AIGOCODE_API_KEY = "填写对应分组的 API Key"

Windows Cmd

set "AIGOCODE_API_KEY=填写对应分组的 API Key"

这些设置仅对当前终端及其启动的程序生效。完整调用示例见 快速开始。

配置 Claude Code、Codex 等工具时,按对应 接入教程 设置工具使用的环境变量或配置字段。

在 SDK 与工具中使用

使用 SDK 时,将完整 Key 填入 api_key 或 apiKey 等密钥参数,由 SDK 生成对应的认证请求头。

使用 AIGoCode Desktop 或 CC Switch 时,通过配置助手完成 Key 与服务地址配置。手动配置的详细步骤见 Agent 工具接入。

更换 Key 或调整分组后,同步更新工具中的配置,并确认目标模型属于当前分组。

常见问题

现象检查项
401 或提示 Key 无效Key 是否复制完整、是否有效,认证字段是否与接口协议对应
403 或提示权限、额度不足当前分组权限,以及账户的套餐额度和灵活额度
提示模型不可用当前 Key 绑定的分组是否包含目标模型,是否适用于当前调用方式
本地可以调用,部署后失败部署环境是否设置了对应环境变量,程序是否读取了正确的变量名
更换分组后调用失败工具中的协议、模型和请求地址是否与新分组匹配

更多状态码说明见 错误码。

保管与更换

将 Key 保存到环境变量或密钥管理器中,避免写入公开代码、Git 仓库和前端页面。分享截图与日志前,先隐藏 Key。

Key 泄露时,在 我的密钥 中删除旧 Key、创建新 Key,并更新使用它的工具或应用。

下一步

  • API Key:创建密钥、选择分组和管理已有 Key。
  • 快速开始:使用三种接口格式完成首次调用。
  • API 兼容协议:了解请求入口、分组与模型之间的关系。
  • Agent 工具接入:完成 Claude Code、Codex 等工具的配置。

本页目录