Get API

GET API · 开发集成

用 Get API 接入 Codex:桌面与 CLI 完整流程

Codex CLI 当前支持自定义 model provider,配置项包括 base_url、env_key 和仅支持的 wire_api = "responses"。Get API 的 Codex 配置使用 https://relay-api.getapi.pro/v1,并从同站控制台取得 Key;模型名必须从当前模型目录选择。桌面流程可通过已核验的 CCSwitch Provider 选择完成,切换后应完全退出并重新启动 Codex。

先确认 Codex 与 Responses 合同

Codex 官方配置参考当前允许自定义 Provider,并把 responses 作为 wire_api 唯一支持值。Get API 后端也公开注册 /v1/responses 路径,因此 Codex 页面使用 Responses 配置,不把聊天端点当作替代证据。

  • 先用 codex --version 确认命令可用
  • Provider 配置放在用户级 config.toml
  • 模型名以 Get API 当前目录为准

Key、地址和模型必须来自同一套配置

Key 来自 getapi.pro 控制台,Base URL 使用 relay-api.getapi.pro,model 使用该 Key 可访问的当前模型名。任一项混用其他服务或过期截图中的名称,都可能产生鉴权或路由错误。

  • 环境变量名与 env_key 完全一致
  • Base URL 保留 /v1
  • 不要把真实 Key 写入 config.toml

切换后重启并做可判定验证

CCSwitch 或配置文件变更不一定被运行中的客户端立即读取。完全退出 Codex 后重新启动,先发送一个不依赖项目上下文的简单任务,再检查实际 Provider、模型名和错误状态。

  • 完全退出而不是只关闭窗口
  • 验证一条最小任务
  • 失败时记录 HTTP 状态而非反复重试

配置 Codex Provider

同一页面覆盖 CCSwitch 桌面选择和 CLI 配置;两条路径共用同一个 Get API Key 与 Base URL。

  1. 从官方入口安装并检查 Codex

    按当前 Codex 官方安装页选择系统对应方式;安装后运行 codex --version,确认终端能识别命令。

  2. 创建适合 Codex 的 Get API Key

    在主站控制台创建 Key,选择能访问目标模型的当前分组,并从模型目录复制可用模型名。

  3. 设置环境变量和用户级配置

    把真实 Key 保存为 GETAPI_PRO_API_KEY,在用户级 config.toml 写入下方 Provider;不要在项目仓库保存密钥。

  4. 在 CCSwitch 中选择 Codex

    桌面流程进入 CCSwitch 的 Codex Provider 区域,确认当前要启用的是 Get API 配置。

    CCSwitch 中的 Codex Provider 选择入口
    在 CCSwitch 顶部选择 Codex,再管理对应 Provider;参考截图界面为中文。
  5. 完全退出并重启 Codex

    保存或切换 Provider 后完全退出运行中的 Codex,再重新打开以读取新配置。

  6. 发送最小任务并核对结果

    先发送简单任务;若失败,核对环境变量、Base URL、model 和 Responses 路径,再查看状态码。

Codex 用户级 config.toml

把 your-model-name 替换为该 Key 当前可访问的模型名;真实 Key 只放在 GETAPI_PRO_API_KEY 环境变量中。

model_provider = "getapi_pro"
model = "your-model-name"

[model_providers.getapi_pro]
name = "GetAPI Pro"
base_url = "https://relay-api.getapi.pro/v1"
env_key = "GETAPI_PRO_API_KEY"
wire_api = "responses"

Codex 接入排错

按状态定位,不要同时重装、换 Key 和换模型。

现象检查项处理动作成功标准
codex 命令不存在安装是否完成,终端 PATH 是否刷新按当前官方安装页重装或重开终端,再运行 codex --version命令输出版本信息
401GETAPI_PRO_API_KEY 是否存在且与 env_key 同名重新在受控环境设置变量,确认 Key 未禁用启动后不再出现鉴权错误
404 或协议错误base_url 是否保留 /v1,wire_api 是否为 responses按示例修正用户级 config.toml 后完全重启请求进入 Responses 路径
模型不可用model 是否来自实时目录且属于该 Key 分组选择当前可访问模型名,不沿用旧截图最小任务获得模型响应
配置未生效是否只关窗口、改错配置层或仍有进程保存用户级配置,完全退出所有 Codex 进程再启动实际 Provider 与新配置一致

常见问题

Codex 接入 Get API 需要哪些配置?

需要 Get API Key、https://relay-api.getapi.pro/v1、当前可访问的模型名,以及自定义 Provider 中的 env_key 和 wire_api = "responses"。

为什么不把真实 Key 写进 config.toml?

配置文件可能被同步、备份或误提交。应只写环境变量名 GETAPI_PRO_API_KEY,把真实值留在受控的本机环境或密钥管理中。

切换 CCSwitch Provider 后为什么没有生效?

运行中的 Codex 可能仍使用旧配置。请保存选择、完全退出所有 Codex 进程,再重新启动并发送最小任务验证。

Codex 可以改用 /chat/completions 吗?

此教程不这样假设。Codex 官方自定义 Provider 当前只支持 responses wire_api,Get API 配置必须通过对应 Responses 路径验证。

商务合作: business@honeykid.cn