返回首页 TOP API DOCS 开 发 文 档
文档 / Codex CLI
TOP API DOCUMENTATION

Codex CLI 接入

Codex CLI 是 OpenAI 官方的终端编码客户端。接到 Top API 需改两处:~/.codex/config.toml(provider 指向 https://top-api.cc)和 ~/.codex/auth.json(填 sk- 密钥)。

OpenAI 协议
Base URL
https://top-api.cc(根域名,不带 /v1
API Key
控制台复制的 sk- 开头密钥,写入 ~/.codex/auth.json(属于 codex pro[特惠] 分组)
推荐模型
gpt-5.6-sol

安装

三种方式任选一种,全局装到 PATH。装好后用 codex --version 看到版本号即可。

  • 方式一 npm:需要 Node.js 18+,跨平台通用。
  • 方式二 Scoop:Windows 推荐。
  • 方式三 Homebrew:macOS / Linux。

方式一:npm(通用)

npm install -g @openai/codex

方式二:Scoop(Windows 推荐)

scoop install codex

没装 Scoop 先跑:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

方式三:Homebrew(macOS / Linux)

brew install codex

配置

第一步:写 config.toml。编辑 ~/.codex/config.toml(Windows 在 C:\Users\<你>\.codex\config.toml),加入下面的 provider 段,注意 base_url 用根域名、wire_apiresponses

model_provider = "my_codex"
model = "gpt-5.6-sol"
model_reasoning_effort = "xhigh"
disable_response_storage = true

[model_providers.my_codex]
name = "top_api"
base_url = "https://top-api.cc"
wire_api = "responses"
requires_openai_auth = true

[tui.model_availability_nux]
"gpt-5.6-sol" = 4

第二步:写 auth.json。密钥不放环境变量,而是写进 ~/.codex/auth.json(Windows 在 C:\Users\<你>\.codex\auth.json),内容就一行 JSON:

{
  "OPENAI_API_KEY": "sk-你的密钥"
}

保存后重启 Codex 即可。在 Codex 里随便发一条消息,能正常回复就行。

  • Base URL 一定用根域名 https://top-api.cc不要带 /v1。带了会被拼成 /v1/v1/... 导致 404。
  • 密钥放在 ~/.codex/auth.jsonOPENAI_API_KEY 字段,不是环境变量。它是控制台「API 密钥」页创建的 sk- 开头密钥,归属 codex pro[特惠] 分组。
  • 提示 401 / 403:检查 auth.json 里的密钥是否填对、是否仍有额度。
  • 遇到问题可客服微信 gtsj-001
配置过程中遇到任何问题,都可以加客服微信 gtsj-001,我们可以帮你检查 Base URL、API Key、模型和客户端配置。
需要帮助?客服微信 gtsj-001 · 文档首页