Skip to content

Codex Proxy API Key 接入文档

本文档用于说明 API Key、代码接入方式,以及 Codex、Claude Code、OpenCode、Cline、Cursor、Trae、Windsurf、Roo Code、Kilo Code 等客户端配置方法。

推荐配置方式

对于 CodexClaude CodeOpenCode 等工具,推荐按以下优先级配置:

  1. 直接修改配置文件(最优先):各工具均有官方配置文件,稳定可靠
  2. 环境变量:适合临时或跨会话配置
  3. cc-switch 工具(备选):https://github.com/farion1231/cc-switch/releases,本质是自动完成上述配置

1. 获取 API Key

  1. 登录你的账户,进入控制台或用户中心。
  2. 在账户相关菜单中找到 API Keys 页面。
  3. 点击创建新 Key,系统会生成一个新的 API Key。
  4. 保存创建时展示的一次性明文 Key,格式类似 codex_xxxxxxxxxxxxxxxx

WARNING

API Key 只在创建时显示一次,页面关闭后无法再次查看原始明文。

TIP

如果你已经关闭了创建弹窗、没有保存原始明文,通常只能删除旧 Key 后重新创建一个新的。

2. Base URL

API Base URL

https://api.gemiaude.com/v1

3. 鉴权方式

所有请求都使用标准 Bearer Token:

http
Authorization: Bearer codex_your_api_key

4. 文档导航

  • 左侧 代码接入:面向 SDK、脚本、后端服务

编程工具接入

  • 左侧 编程工具接入 / Codex:Codex CLI 配置
  • 左侧 编程工具接入 / OpenClaw:OpenClaw 配置
  • 左侧 编程工具接入 / OpenCode:OpenCode 配置
  • 左侧 编程工具接入 / Claude Code:Claude Code 配置
  • 左侧 编程工具接入 / Cline:Cline 的 OpenAI Compatible provider 配置
  • 左侧 编程工具接入 / Cursor:Cursor 的自定义 OpenAI 兼容配置
  • 左侧 编程工具接入 / Trae:Trae 的自定义 OpenAI 兼容配置
  • 左侧 编程工具接入 / Windsurf:Windsurf 的自定义 OpenAI 兼容配置
  • 左侧 编程工具接入 / Roo Code:Roo Code 的 OpenAI Compatible provider 配置
  • 左侧 编程工具接入 / Kilo Code:Kilo Code 的 OpenAI Compatible provider 配置

聊天 / 娱乐工具接入

  • 左侧 聊天 / 娱乐工具接入 / SillyTavern(酒馆):SillyTavern OpenAI 兼容接口配置
  • 左侧 聊天 / 娱乐工具接入 / TavernAI(Tavo):TavernAI OpenAI 兼容接口配置
  • 左侧 聊天 / 娱乐工具接入 / NativeTavern:NativeTavern iOS/macOS 原生客户端配置
  • 左侧 聊天 / 娱乐工具接入 / Cherry Studio:Cherry Studio 自定义服务商配置
  • 左侧 聊天 / 娱乐工具接入 / Chatbot UI:Chatbot UI 自定义接口配置
  • 左侧 聊天 / 娱乐工具接入 / LobeChat:LobeChat OpenAI 代理配置
  • 左侧 聊天 / 娱乐工具接入 / NextChat:NextChat 自定义接口配置
  • 左侧 聊天 / 娱乐工具接入 / Chatbox:Chatbox OpenAI 兼容配置

5. 支持的接口

方法路径说明
GET/v1/models获取当前网关可见模型列表
POST/v1/chat/completionsOpenAI Chat Completions 兼容接口
POST/v1/responsesOpenAI Responses 兼容接口
POST/v1/embeddings向量接口,默认模型是 text-embedding-3-small
POST/v1/messagesAnthropic Messages 兼容接口,适用于 Claude Code 等客户端

6. 常见错误码

状态码含义
401API Key 无效、已停用,或 Header 没带 Bearer Token
402账户当前不可用,或没有可用调用额度
403用户被禁用,或当前模型访问受限
429达到并发限制,或触发频率限制
503没有可用上游渠道,或所有渠道都失败

OpenAI-compatible gateway integration docs