Codex5 文档

快速接入 Codex5 API

Codex5 提供 OpenAI 兼容的 API 接入。创建 API 密钥后,把 Base URL 填为 https://www.codex5.net/v1,即可在 Codex CLI、CC Switch、Chatbox、Cherry Studio 等客户端中使用。

主站地址 https://www.codex5.net
API 请求地址 https://www.codex5.net/v1
密钥位置 登录控制台后,在 API 密钥页面创建并复制。

账户和 API 密钥

首次使用时,先确认账户余额,再创建 API 密钥。完整密钥只会在创建时显示一次,复制后请保存在本地安全位置。

  1. 登录 Codex5。打开 https://www.codex5.net,进入控制台。
  2. 准备余额。在充值或钱包页面完成账户充值,避免客户端请求时余额不足。
  3. 创建密钥。进入 API 密钥页面,新建一个专门给客户端使用的密钥。
  4. 配置客户端。Base URL 填 https://www.codex5.net/v1,API Key 填刚创建的密钥。
建议:不同工具可以使用不同密钥,后续查账、停用或排查错误会更清楚。

Codex CLI

Codex CLI 使用 OpenAI 兼容协议,Base URL 需要包含 /v1。推荐把密钥放在环境变量里,不要写进项目代码或截图。

OpenAI 兼容 Base URL:https://www.codex5.net/v1
安装 Codex CLI
npm i -g @openai/codex
codex --version
环境变量
export OPENAI_API_KEY="你的 Codex5 API 密钥"
export OPENAI_BASE_URL="https://www.codex5.net/v1"
~/.codex/config.toml 示例
model_provider = "codex5"
model = "gpt-5"

[model_providers.codex5]
name = "Codex5"
base_url = "https://www.codex5.net/v1"
env_key = "OPENAI_API_KEY"

CC Switch 配置

CC Switch 里选择 Codex 供应商,再使用自定义配置。按下面字段填写即可,供应商名称可以随便写,建议填 Codex5default

供应商名称 随便填写,建议 Codex5default 或你的团队名称。
官网链接 https://www.codex5.net
API Key 填写 Codex5 控制台生成的 API 密钥。只需要填这里,下方 auth.json 会自动填充。
API 请求地址 https://www.codex5.net/v1
  1. 点击右上角加号。进入“添加新供应商”。
  2. 选择 Codex 供应商。在预设供应商中选择“自定义配置”。
  3. 填写四个字段。官网链接填主站,API 请求地址填带 /v1 的完整地址。
  4. 保存并选择。添加后回到供应商列表,选中刚创建的 Codex5 配置。
CC Switch 供应商列表中选中 Codex5 配置
供应商列表里,选中你新增的 Codex5 配置。
CC Switch 添加新供应商选择自定义配置
添加新供应商时选择 Codex 供应商下的自定义配置。
CC Switch 自定义供应商字段填写示例
官网链接、API Key、API 请求地址按图填写;API Key 使用网站生成的密钥。

Claude Code

如果客户端支持 OpenAI 兼容接口,可以直接使用 Codex5 的 /v1 地址。如果客户端要求 Anthropic 原生协议,请先确认所选模型和客户端是否支持对应协议。

OpenAI 兼容模式
export OPENAI_API_KEY="你的 Codex5 API 密钥"
export OPENAI_BASE_URL="https://www.codex5.net/v1"
排查端点
curl https://www.codex5.net/v1/models \
  -H "Authorization: Bearer $OPENAI_API_KEY"

其他客户端

大多数客户端只需要 Base URL、模型名和 API Key。只要是 OpenAI 兼容协议,Base URL 都填写 https://www.codex5.net/v1

客户端/用途 Base URL 说明
Chatbox / Cherry Studio https://www.codex5.net/v1 选择 OpenAI 兼容供应商,填入 API Key 和模型名。
Cursor / Cline https://www.codex5.net/v1 在自定义模型或 OpenAI Compatible 设置中填写。
Dify / N8N / 自写程序 https://www.codex5.net/v1 请求头使用 Authorization: Bearer sk-...

常用命令

命令 用途 建议场景
/help 查看当前客户端支持的命令和快捷键。 刚安装或升级后先看一遍。
/clear 清空当前会话上下文。 换任务、上下文混乱时使用。
/compact 压缩当前上下文,保留关键进度。 长任务跑久了但还要继续。
/model 查看或切换模型。 需要在速度、成本和能力之间切换时使用。

故障排查

401 或密钥无效

确认 API Key 复制完整,没有多余空格,且密钥没有被禁用或过期。完整密钥只在创建后显示一次,丢失后需要重新创建。

端点不匹配

OpenAI 兼容客户端必须填写 https://www.codex5.net/v1。少了 /v1 是最常见的问题。

余额不足或分组不对

确认账户余额充足,并确认密钥允许访问你选择的模型。不同模型建议使用单独密钥方便排查。

客户端连接失败

先用浏览器打开 https://www.codex5.net,再检查代理、防火墙和 DNS。命令行可用 curl -I https://www.codex5.net/v1/models 测试连通性。