OpenAI Codex 集成指南

Codex CLI 通过 OpenAI 兼容接口(Responses API)接入 KOPRouter,用你自己的 Key 完成代码任务。

**前置条件**
  • Node.js 18 或更新版本(Codex CLI 运行环境)

安装 Codex CLI

在命令行执行以下命令安装:

npm i -g @openai/codex

安装后执行 codex --version,能显示版本号即安装成功(需 0.138 及以上版本)。

核心配置

接入 KOPRouter 需要三个参数:

  • 模型:KOPRouter 中的模型 ID,取自 /v1/models 返回的 id
  • Base URL:https://koprouter.kopglobal.com/v1(需以 /v1 结尾,Codex 会在其后追加 /responses)
  • API Key:你的 KOPRouter API Key(sk- 开头)

方式一:全部写入 config.toml(推荐)

在配置文件里一步到位填好模型供应商与 API Key,无需再设置环境变量。

文件路径为 `~/.codex/config.toml`。若 `.codex` 目录不存在,先创建:
```bash
mkdir -p ~/.codex
nano ~/.codex/config.toml
```
文件路径为 `%USERPROFILE%\.codex\config.toml`(通常为 `C:\Users\<用户名>\.codex\config.toml`)。以 CMD 为例:
```bat
if not exist "%USERPROFILE%\.codex" mkdir "%USERPROFILE%\.codex"
notepad "%USERPROFILE%\.codex\config.toml"
```

写入以下内容:

model = "MODEL_ID"
model_provider = "koprouter"

[model_providers.koprouter]
name = "KOPRouter"
base_url = "https://koprouter.kopglobal.com/v1"
wire_api = "responses"
experimental_bearer_token = "sk-..."

保存后直接运行 codex 即可。

内联 Key 以明文存储:请执行 `chmod 600 ~/.codex/config.toml` 且勿提交进 git。不要使用已废弃的 `api_key` 字段(Codex 0.151 起被静默忽略)。 可选:若所选上游模型支持推理摘要,可在 `model` 附近加一行 `model_supports_reasoning_summaries = true` 开启;不确定时先不配置。

方式二:通过环境变量提供 Key

若不想把 Key 明文写进配置文件,可让 Codex 从环境变量读取:把上面的 experimental_bearer_token 一行替换为 env_key = "KOPROUTER_API_KEY",然后设置环境变量。

先查看当前 Shell 类型:
```bash
echo $SHELL
```

* **Zsh**:写入 `~/.zshrc`
* **Bash**:写入 `~/.bashrc`

```bash
echo 'export KOPROUTER_API_KEY="sk-..."' >> ~/.zshrc
source ~/.zshrc
```

(Bash 用户把 `~/.zshrc` 换成 `~/.bashrc`。)
**CMD**(设置后新开 CMD 窗口生效):
```bat
setx KOPROUTER_API_KEY "sk-..."
echo %KOPROUTER_API_KEY%
```

**PowerShell**(设置后新开 PowerShell 窗口生效):

```powershell
[Environment]::SetEnvironmentVariable("KOPROUTER_API_KEY", "sk-...", [EnvironmentVariableTarget]::User)
echo $env:KOPROUTER_API_KEY
```
`experimental_bearer_token` 与 `env_key` 互斥,二者只能写一个。

使用

codex

首次可先跑一个最小任务验证链路:

codex exec "echo hello"
* `base_url` 必须以 `/v1` 结尾,Codex 会在其后追加 `/responses`。 * `wire_api` 必须为 `responses`;新版 Codex 已移除 `chat`(Chat Completions)支持,写成 `chat` 会直接报错。 * `model_provider` 的 id 请勿使用 `openai` / `ollama` / `lmstudio` 等保留 id,否则覆盖无效。 **关于 Responses API 透传**

KOPRouter 的 /v1/responses 会原样转发到该模型背后的上游渠道,本身不做 Responses ↔ Chat Completions 转换。因此只有当上游渠道原生支持 Responses API(如 OpenAI、Azure OpenAI、xAI 等)时,Codex 才能正常使用;若上游仅支持 Chat Completions(如 DeepSeek、Moonshot、Mistral、Groq、Zhipu 等),请求会失败,需换用支持 Responses API 的模型。

**无法连接(网络受限)?**

若所在网络无法直连 KOPRouter(如中国大陆),需先配置 VPN 或代理。Codex CLI 的 config.toml 没有代理项,只能读取 HTTPS_PROXY / HTTP_PROXY 环境变量,请按「网络与代理配置」中的「方案三」设置。