使用指南
返回主页

外观

Codex 配置 ​

Codex 同时提供桌面版和 CLI。第一次使用推荐桌面版；一键配置对两种方式都有效，不需要自己创建 config.toml 或 auth.json。

在控制台左侧点击“API 密钥”，找到支持 Codex 模型的密钥，点击这一行的“使用密钥”。在弹窗中选择 Codex → 兼容模式 → 当前操作系统 → 下载一键配置，运行下载的文件后重启 Codex。本页按截图中的“兼容模式”介绍常规接入；“Codex (WebSocket)”和“API Key Mode”是另外的选项。

先选择你使用的 Codex

两种方式使用同一个配置目录，下面的一键配置都适用。

1安装 Codex 桌面版

打开桌面版安装说明

已经安装可以直接进入下一步。一键配置同时适用于 Codex 桌面版和 CLI。

2创建 API 密钥

API 密钥（API Key）是客户端访问服务时使用的凭证。打开控制台左侧的“API 密钥”，找到准备使用的密钥；还没有时，先点击右上角“创建密钥”并完成创建。

确认密钥所属分组支持 Codex 使用的模型。截图中的密钥名称和分组仅为示例。

打开 API 密钥页面

3下载并运行一键配置

在目标密钥这一行的“操作”列点击 使用密钥，打开“使用 API 密钥”弹窗。

点击弹窗中的“Codex”选项卡。 “Codex 认证模式”保持“兼容模式”。 再选择当前操作系统，然后点击 下载一键配置脚本。 Codex 桌面版和 CLI 共用同一个配置目录。

下载后打开终端（输入并执行命令的窗口），输入 sh 和一个空格，把下载的 .sh 文件拖入终端，然后按回车。等待脚本执行完成，再进行下一步。

看图操作

Codex 配置流程图

按照新版控制台截图，在“API 密钥”页点击“使用密钥”，选择 Codex 和当前操作系统，下载并运行一键配置脚本，最后重启客户端验证。

截图中的供应商名称是示例，仅用于定位操作入口。实际供应商名称或 ID 统一填写 custom；地址、密钥和模型请使用本页复制区的值。

界面可能随版本变化
  1. 第 1 步

    在“API 密钥”页点击“使用密钥”

    1. 1

      在目标密钥这一行的“操作”列点击“使用密钥”。

    点击控制台左侧“API 密钥”，找到支持 Codex 模型的密钥，在这一行的“操作”列点击“使用密钥”。还没有密钥时，先点击右上角“创建密钥”并完成创建。截图中的名称和分组仅为示例，缩略密钥不能用于配置。

    自行采集用户提供的控制台界面（版本未标注）
  2. 第 2 步

    选择 Codex 并下载一键配置脚本

    1. 1

      在顶部选择 Codex，认证模式保持“兼容模式”。

    2. 2

      选择自己的操作系统后，点击“下载一键配置脚本”，按本页说明运行下载的文件。

    点击顶部“Codex”选项卡，在“Codex 认证模式”中保持“兼容模式”，再选择自己的操作系统。截图中选中的是“macOS / Linux”，点击绿色区域中的“下载一键配置脚本”；下载后打开终端，输入 sh 和一个空格，将下载的 .sh 文件拖入终端并按回车。等待脚本执行完成，再重新打开 Codex。

    自行采集用户提供的控制台界面（macOS / Linux，版本未标注）
  3. 第 3 步

    重新打开 Codex 并确认模型

    1. 1

      确认这里显示的是配置中的模型。

    2. 2

      在输入区提交一个只读取当前目录的简单任务。

    重新启动后，先确认顶部显示的是预期模型，再输入一个简单任务进行验证。

看不清时：点击图片可放大；配置值请复制页面中的文字，不要照着截图手工输入密钥或地址。

4重启并验证

完全退出 Codex 桌面版，重新打开并新建一个任务。只关闭窗口可能不会重新加载配置。

新建任务后输入：说明当前目录包含哪些文件

能够正常返回内容，就表示配置成功。

一键配置文件包含你的 API 密钥。配置完成后请妥善保管或删除下载文件。

一键配置不可用时，查看手动配置

配置文件是客户端启动时读取设置的文本文件。打开下面路径对应的文件，复制本页配置，将 sk-your-api-key 替换为自己的完整 API Key，然后保存。已有配置时先备份，并合并需要的字段，避免覆盖其他设置。

~/.codex/config.toml

model_provider = "custom"
model = "gpt-5.6-sol"
review_model = "gpt-5.6-sol"
model_reasoning_effort = "high"

[model_providers.custom]
name = "custom"
base_url = ""
wire_api = "responses"
requires_openai_auth = true

~/.codex/auth.json

{
  "OPENAI_API_KEY": "sk-your-api-key"
}

如何确认配置成功 ​

桌面版重新打开后，新建一个任务并发送一句简单请求，例如“说明当前目录包含哪些文件”。CLI 用户运行 codex 后发送同样的请求。能够正常返回内容即表示接入成功。

如果 Codex 仍然要求登录，请先完全退出 Codex Desktop 或 CLI，再重新打开并新建任务。仍未解决时，检查 ~/.codex 或 %USERPROFILE%\.codex 中是否已经生成配置文件。

更新配置 ​

更换 API Key、API 地址或模型后，重新下载并运行一键配置即可。建议不要同时保留多套指向不同服务商的同名配置。

常见问题 ​

  • 401：API Key 不正确、已删除或复制不完整。
  • 403：当前 Key 没有对应分组或模型权限。
  • 429：余额、并发数或速率限制不足。
  • 一直连接：检查网络、代理以及 API 地址是否可以访问。
  • 模型不存在：确认当前密钥所属分组支持所选模型，并使用页面提供的模型名称。
  • 地址中重复出现 /v1：使用页面显示的 API 地址，不要自行重复追加路径。
  • 配置没有生效：检查其他工具是否覆盖了 ~/.codex 中的配置，完全退出 Codex 后重新启动。
  • 在容器或远程电脑中运行 CLI：确认运行 CLI 的那台电脑可以访问 API 地址；本机浏览器能打开页面不代表容器网络可用。

更多处理方法见常见问题。