Codex Guide

Codex 接入教程

如果你使用 Codex 进行代码生成、CLI 工作流或项目开发,通常只需要配置模型提供方地址和 API Key,就可以通过 CodeAPI 完成接入。

Prepare

开始前需要准备什么

先确认密钥与客户端都已就绪,再进入具体配置。

  • 一个可登录的 CodeAPI 控制台账号
  • 一个有效的 API Key
  • 本地已安装 Codex
Platform & Tools

支持平台与常见搭配工具

Codex 常见 CLI 环境和编辑器终端都能直接复用这套配置。

支持平台

  • Windows:适合本地项目、PowerShell 和开发机工作流
  • macOS:适合个人开发和多项目切换场景
  • Linux:适合远程开发机、服务器和自动化任务

常见搭配工具

  • 终端:直接运行 Codex CLI 或脚本化命令
  • VS Code / JetBrains:在内置终端沿用同一套配置
  • CC-Switch:适合可视化切换 Provider 和模型

适合的工作流

更适合代码生成、项目修改、CLI 自动化和本地仓库协作流程。只要客户端遵循 OpenAI 兼容配置,这套 Base URL 和 API Key 写法通常都能复用。

config.toml

先配置 model provider

首先在本地 Codex 配置里新增一个模型提供方,并把请求地址指向 CodeAPI。

config.toml 示例

model_provider = "codeapi"
model = "gpt-5-codex"

[model_providers.codeapi]
name = "codeapi"
base_url = "https://api.codeapi.work/v1"
wire_api = "responses"
requires_openai_auth = true
auth.json

再写入 API Key

provider 配置完成后,再通过 auth.json 或环境变量写入 API Key,避免把认证信息混在 provider 配置中。

auth.json 示例

{
  "OPENAI_API_KEY": "sk-your-token"
}

环境变量示例

$env:OPENAI_BASE_URL = "https://api.codeapi.work/v1"
$env:OPENAI_API_KEY = "sk-your-token"
Verify

如何验证配置成功

完成配置后,重新打开终端并尝试运行 Codex。如果可以正常进入工作流或返回结果,通常说明配置已生效。

优先检查项

  • OPENAI_BASE_URL 是否正确
  • API Key 是否正确
  • 模型名是否与当前配置一致

特别容易漏掉的点

如果你同时改过配置文件和环境变量,旧终端环境仍可能覆盖新配置。遇到这种情况,先完全关闭终端再验证。

Troubleshoot

常见问题排查

先排查这几类高频问题,通常能很快定位配置异常。

Codex 无法连接 API

优先检查 OPENAI_BASE_URL 是否正确,再确认 auth.json 中的 API Key 填写无误。

模型不可用

通常表示模型名填写错误,或当前调用方式与模型不匹配。优先回到 config.toml 检查模型字段。

配置已修改但没有生效

通常是旧终端环境仍在生效,建议完全关闭并重新打开终端后再次验证。

下一步建议

如果 Codex 已接入成功,建议继续查看价格页和 FAQ 页,了解计费方式、用量控制和常见问题处理方式。