客户端接入
Codex 配置教程
安装 OpenAI Codex CLI,并通过 CokeAPI Responses 兼容接口调用 Codex 模型。
Codex CLI 可以通过 OpenAI Responses 协议接入 CokeAPI。参考配置的核心是:auth.json 写入 API Key,config.toml 指向 https://cokeapi.com/v1,并把 wire_api 设置为 responses。
请把示例里的 sk-xxxxxxxx 替换成你在 CokeAPI 控制台创建的真实 API Key。不要把真实 Key 写进公开仓库、截图或团队共享文档。
通用配置
| 配置项 | 填写内容 | 说明 |
|---|---|---|
| API Key | sk-xxxxxxxx | CokeAPI 控制台创建的 Key |
| Base URL | https://cokeapi.com/v1 | Codex CLI 会在此基础上调用 Responses 接口 |
| wire_api | responses | Codex CLI 推荐使用 Responses 协议 |
| model | codex-5.3 | 也可换成 模型一览 中可用的 Codex 模型 |
| model_reasoning_effort | high / medium / low | 模型思考强度,越高越慢但更适合复杂任务 |
Windows 版本教程
系统要求
| 项目 | 要求 |
|---|---|
| 系统 | Windows 10 / Windows 11 |
| Node.js | 22+ |
| npm | 10+ |
| 终端 | PowerShell / CMD / Git Bash |
建议先安装 Git Bash,再安装 Node.js LTS。
安装 Codex
npm install -g @openai/codex
codex --version创建配置文件
进入当前用户目录下的 .codex 文件夹,例如:
C:\Users\your-name\.codex如果没有该目录,请手动创建,并创建两个文件:
auth.json
config.tomlauth.json:
{"OPENAI_API_KEY": "sk-xxxxxxxx"}config.toml:
model_provider = "cokeapi"
model = "codex-5.3"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
[model_providers.cokeapi]
name = "CokeAPI"
base_url = "https://cokeapi.com/v1"
wire_api = "responses"macOS 版本教程
安装 Node.js
推荐使用 Homebrew:
brew install node
node --version
npm --version也可以直接从 Node.js 官网 下载 LTS 安装包。
安装 Codex
npm install -g @openai/codex
codex --version写入配置
mkdir -p ~/.codex
touch ~/.codex/auth.json ~/.codex/config.toml~/.codex/auth.json:
{"OPENAI_API_KEY": "sk-xxxxxxxx"}~/.codex/config.toml:
model_provider = "cokeapi"
model = "codex-5.3"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
[model_providers.cokeapi]
name = "CokeAPI"
base_url = "https://cokeapi.com/v1"
wire_api = "responses"保存后请重启终端。
Linux 版本教程
安装 Node.js
Ubuntu / Debian:
sudo apt update
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejsFedora / CentOS / RHEL:
sudo dnf install nodejs npm
# 或
sudo yum install nodejs npmArch Linux:
sudo pacman -S nodejs npm安装 Codex
sudo npm install -g @openai/codex
codex --version写入配置
mkdir -p ~/.codex
cat > ~/.codex/auth.json <<'EOF'
{"OPENAI_API_KEY": "sk-xxxxxxxx"}
EOF
cat > ~/.codex/config.toml <<'EOF'
model_provider = "cokeapi"
model = "codex-5.3"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
[model_providers.cokeapi]
name = "CokeAPI"
base_url = "https://cokeapi.com/v1"
wire_api = "responses"
EOF启动 Codex
配置完成后,重启终端,进入你的项目目录:
cd your-project-folder
codex如果使用 VSCode 插件,先按上面的 CLI 配置写好 ~/.codex/auth.json 和 ~/.codex/config.toml,再在 VSCode 扩展商店搜索并安装 codex。
常见问题
| 问题 | 排查方式 |
|---|---|
model not configured | 确认 model 使用 模型一览 中存在的 Codex 模型,如 codex-5.3 |
| 401 / API Key 无效 | 检查 auth.json 中的 Key 是否以 sk- 开头,是否复制完整 |
| 403 / scope 不足 | 重新创建 Key,并确保包含文本/聊天调用权限 |
| 请求走错接口 | 确认 wire_api = "responses",且 base_url = "https://cokeapi.com/v1" |
| 配置没生效 | 重启终端或 VSCode,再重新运行 codex |