使用教程
Codex
使用 OpenAI 兼容方式把 Codex 接入你的网关服务。
适用说明
如果你的站点已经改名,或者 API 网关与文档站不是同一个域名,只需要把下面示例替换成你的实际配置即可。 Codex 一般通过 OpenAI 兼容接口接入,最常用的是:
- OpenAI Base URL,例如
https://api.example.com/v1 - API Key,例如
sk-your-token - Model,后台实际开放给你的模型名
建议的连通性测试
Codex curl 示例
先用模型列表接口确认 Base URL 和访问令牌可用。
curl
curl https://api.example.com/v1/models \ -H "Authorization: Bearer sk-your-token"
访问令牌
sk-your-token
OpenAI Base URL
https://api.example.com/v1
安装 Codex
安装 Codex
先安装官方 CLI。
bash
npm install -g @openai/codex
检查命令
确认安装后可以直接执行。
bash
codex --version
使用环境变量启动
macOS / Linux
macOS / Linux
临时写入当前终端会话。
shell
export OPENAI_API_KEY="sk-your-token" export OPENAI_BASE_URL="https://api.example.com/v1" codex
PowerShell
PowerShell
当前 PowerShell 会话内临时生效。
powershell
$env:OPENAI_API_KEY="sk-your-token" $env:OPENAI_BASE_URL="https://api.example.com/v1" codex
写入 Codex 配置文件
Codex 配置文件
把网关信息写进 `~/.codex/config.toml`。
toml
model = "your-model-name" model_provider = "gateway" [model_providers.gateway] name = "gateway" base_url = "https://api.example.com/v1" env_key = "OPENAI_API_KEY" wire_api = "responses"
说明:
model填写后台已开放的模型名base_url填写 OpenAI 兼容入口wire_api = "responses"适合走/v1/responses的场景model_provider和段名只是本地别名,可以改成你喜欢的名字
连通性测试
连通性测试
再用模型列表接口验证一次。
curl
curl https://api.example.com/v1/models \ -H "Authorization: Bearer sk-your-token"
如果模型列表可以正常返回,再启动 codex 会更稳定。
常见排查
1. 无法连接服务
优先检查 OPENAI_BASE_URL 是否包含 /v1。
2. unauthorized
确认 OPENAI_API_KEY 是否写成了后台创建的有效令牌。
3. model not found
说明配置文件里的 model 和后台实际开放的模型名称不一致。