OpenAI Codex
OpenAI Codex 是面向软件开发的编码 Agent，支持在本地终端中阅读代码、修改文件、运行命令、解释项目并协助完成开发任务。这里的接入说明主要面向 Codex CLI，用于将 Codex CLI 的模型 provider 配置为彼源 AI。
Codex Web、Codex App 和 Codex IDE Extension 的登录与权限通常由 OpenAI 官方账户体系管理。本页重点说明 Codex CLI 的自定义 provider 配置，不代表所有 Codex 产品形态都可以用同样方式接入第三方 endpoint。
安装 Codex CLI
如本机尚未安装 Codex CLI，可使用官方 npm 包安装：
npm i -g @openai/codex
安装完成后执行：
codex --version
如果能够输出版本号，说明 Codex CLI 已可在当前终端中使用。
适用场景
- 希望在终端中使用 Codex 处理本地代码仓库。
- 希望通过彼源 AI 令牌接入可用模型。
- 希望把 Codex CLI 的使用日志、额度和权限统一纳入彼源 AI 控制台管理。
- 希望为 Codex CLI 单独配置模型 provider，而不影响其他客户端。
前置条件
开始前，请先准备以下信息：
| 项目 | 说明 |
|---|---|
| Codex CLI | 已安装并可运行 codex 命令 |
| API endpoint | https://api.biyuan.ai/v1 |
| 彼源 AI 令牌 | 在“令牌管理”中创建的 sk- 开头令牌 |
| 模型名称 | 从模型广场复制适合 Codex CLI 的模型 ID；令牌设置了模型限制时，以 GET /v1/models 返回为准 |
建议为 Codex CLI 单独创建令牌，不要复用生产服务、团队共享或其他客户端正在使用的高权限令牌。
接入流程
创建 Codex CLI 专用令牌
-> 确认可用模型
-> 写入 Codex CLI provider 配置
-> 设置彼源 AI 令牌环境变量
-> 使用 profile 启动 Codex
-> 发送一次测试请求
如何接入
1. 创建 Codex CLI 专用令牌
进入彼源 AI 控制台：
令牌管理 -> 添加令牌
建议命名为 codex-cli-mac、codex-cli-work、codex-cli-project 等便于识别的名称。这样后续查看消耗、停用令牌或排查请求时更清晰。
2. 确认可用模型
在控制台中查看当前令牌可用的模型。首次接入建议只选择一个模型完成验证，确认 Codex CLI 与彼源 AI 之间的链路正常后，再切换或增加其他模型。
模型名称需要与控制台显示保持一致。例如：
gpt-5.3-codex
如使用其他模型，请以当前控制台中可见、可调用的名称为准。
3. 配置 Codex provider
打开或创建 Codex CLI 用户配置文件：
~/.codex/config.toml
加入一个彼源 AI provider 和对应 profile：
[model_providers.biyuan]
name = "Biyuan"
base_url = "https://api.biyuan.ai/v1"
env_key = "BIYUAN_API_KEY"
wire_api = "responses"
[profiles.biyuan]
model_provider = "biyuan"
model = "gpt-5.3-codex"
model_reasoning_effort = "medium"
字段说明：
| 字段 | 说明 |
|---|---|
model_providers.biyuan | 自定义 provider 名称，可保持为 biyuan |
base_url | 彼源 AI API endpoint，需要包含 /v1 |
env_key | Codex CLI 读取令牌的环境变量名 |
wire_api | Codex CLI 与 provider 通信使用的协议，保持为 responses |
profiles.biyuan | 启动时可选择的配置档 |
model | 默认模型名称，以彼源 AI 控制台可用模型为准 |
建议使用 profile 方式接入，避免直接覆盖当前 Codex CLI 的默认 OpenAI 配置。
4. 设置彼源 AI 令牌
在启动 Codex CLI 前，在同一个终端窗口中设置环境变量：
export BIYUAN_API_KEY="<你的彼源 AI 令牌>"
示例：
export BIYUAN_API_KEY="sk-..."
请勿把真实令牌写入公开文档、截图、代码仓库或聊天记录中。
5. 使用彼源 AI profile 启动 Codex
进入项目目录后启动 Codex：
cd /path/to/your/project
codex --profile biyuan
也可以在启动时临时指定模型：
codex --profile biyuan --model gpt-5.3-codex
启动后发送一个简单请求：
请总结这个项目的目录结构，并说明主要入口文件。
如果 Codex 能正常返回，回到彼源 AI 控制台，打开「使用日志」，能看到刚才这条请求（模型、时间、消耗），说明接入成功。
验证方法
推荐按以下顺序验证：
- 执行
codex --version，确认 Codex CLI 已安装。 - 检查
~/.codex/config.toml中是否存在model_providers.biyuan。 - 在同一终端中执行
echo $BIYUAN_API_KEY，确认令牌环境变量已生效。 - 使用
codex --profile biyuan启动。 - 发送一条简单请求。
- 回到彼源 AI 控制台，打开「使用日志」，能看到刚才这条请求（模型、时间、消耗），说明接入成功。
注意事项
- 本页主要适用于 Codex CLI，不适用于 Codex Web/App 的默认登录路径。
- Codex CLI 的自定义 provider 当前更适合高级用户配置，首次接入建议先小范围验证。
wire_api请保持为responses，不要改成其他值。- 彼源 AI 侧需要当前模型可通过 Responses 风格接口调用，否则可能出现请求失败。
- 不建议把真实令牌直接写入
config.toml，优先使用环境变量。
常见问题
Base URL 应该填写什么
填写：
https://api.biyuan.ai/v1
Codex CLI 的自定义 provider 配置需要写入 API base URL。彼源 AI 的 Responses 接口位于 /v1/responses，因此这里需要包含 /v1。
可以直接在 Codex Web 或 App 中这样配置吗
不建议这样理解。Codex Web、Codex App 和 IDE Extension 通常走 OpenAI 官方账户体系。本页配置方式面向 Codex CLI 的自定义 provider。
提示找不到 provider 或 profile
请检查：
~/.codex/config.toml文件路径是否正确。[model_providers.biyuan]和[profiles.biyuan]是否完整。- TOML 语法是否正确，例如引号、方括号和换行。
- 启动命令是否使用了
codex --profile biyuan。
提示未设置 API Key
请确认当前终端中已经设置：
export BIYUAN_API_KEY="<你的彼源 AI 令牌>"
如果是在新的终端窗口启动 Codex，需要重新设置该环境变量，或将其写入本机安全的 shell 配置中。
模型无法调用
常见原因包括：
- 模型名称与控制台显示不一致。
- 当前令牌没有目标模型权限。
- 当前模型不适合 Codex CLI 的 Responses 调用方式。
- 令牌额度不足或已被停用。
建议先换用一个已确认可调用的模型完成最小验证，再继续排查目标模型。
如何确认请求是否经过彼源 AI
最直接的方式是回到彼源 AI 控制台，打开「使用日志」，看是否有刚才这条请求。若 Codex CLI 返回成功，但「使用日志」中没有这条请求，通常说明当前 profile 未生效，或 Codex 仍在使用原有 provider。