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,无需再设置环境变量。
```bash
mkdir -p ~/.codex
nano ~/.codex/config.toml
```
```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
若不想把 Key 明文写进配置文件,可让 Codex 从环境变量读取:把上面的 experimental_bearer_token 一行替换为 env_key = "KOPROUTER_API_KEY",然后设置环境变量。
```bash
echo $SHELL
```
* **Zsh**:写入 `~/.zshrc`
* **Bash**:写入 `~/.bashrc`
```bash
echo 'export KOPROUTER_API_KEY="sk-..."' >> ~/.zshrc
source ~/.zshrc
```
(Bash 用户把 `~/.zshrc` 换成 `~/.bashrc`。)
```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
```
使用
codex
首次可先跑一个最小任务验证链路:
codex exec "echo hello"
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 环境变量,请按「网络与代理配置」中的「方案三」设置。