文档›接入指南
OpenAI 兼容协议● 服务状态
CODEX API · DEVELOPER GUIDE

用熟悉的接口,
连接你的 AI 应用。

Codex API 提供 OpenAI 兼容的模型接口。创建密钥、选择可用模型,即可从常见 SDK 或 HTTP 客户端发起请求。

API 基础地址https://codex-api1.com/v1
01 / 密钥

创建专用 API Key

在控制台密钥页创建并绑定可用分组。

02 / 模型

按 Key 权限选模型

模型广场展示当前开放模型和实时费率。

03 / 调用

发送兼容请求

使用 Chat Completions 路径和 Bearer 认证。

01

创建 API 密钥

建议为每个应用或环境单独创建密钥,便于管理和停用。

1
登录 Codex API 控制台

前往 API 密钥 页面。

2
新建密钥并选择分组

确认分组允许访问你准备调用的模型;模型权限由密钥分组决定。

3
安全保存密钥

将密钥放入服务器环境变量或密钥管理器,不要提交到代码仓库或发到公开聊天。

API Key 具有账户调用权限。若误泄露,请在控制台停用并创建新密钥。
02

接口地址

服务地址采用 HTTPS;OpenAI 兼容聊天接口使用标准 JSON 请求。

用途地址方法
API 基础地址https://codex-api1.com/v1—
聊天补全/v1/chat/completionsPOST
模型列表/v1/modelsGET

API Key 放在请求头:Authorization: Bearer YOUR_API_KEY

03

cURL 示例

把占位符替换为你自己的 API Key 和有权限使用的模型 ID。

bash · Chat Completions
curl https://codex-api1.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $CODEX_API_KEY" \
  -d '{
    "model": "gpt-6-sol",
    "messages": [
      {"role": "user", "content": "用一句话介绍 API。"}
    ]
  }'
04

Python SDK

OpenAI Python SDK 可通过自定义 base_url 连接兼容接口。

Python
from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["CODEX_API_KEY"],
    base_url="https://codex-api1.com/v1",
)

response = client.chat.completions.create(
    model="gpt-6-sol",
    messages=[{"role": "user", "content": "你好!"}],
)
print(response.choices[0].message.content)

安装依赖:pip install openai

05

Node.js SDK

使用官方 JavaScript SDK,通过环境变量管理密钥。

JavaScript · ESM
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.CODEX_API_KEY,
  baseURL: "https://codex-api1.com/v1",
});

const result = await client.chat.completions.create({
  model: "gpt-6-sol",
  messages: [{ role: "user", content: "你好!" }],
});
console.log(result.choices[0].message.content);

安装依赖:npm install openai

06

模型与分组

模型清单、可用端点和价格会变化,请以模型广场和你的 Key 权限为准。

gpt-6-solOpenAI 兼容 · openai低价 分组
gpt-6.1-solOpenAI 兼容 · codex不降智 分组
gpt-6-astraOpenAI 兼容 · codex不降智 分组
gpt-5.6-solOpenAI 兼容 · codex不降智 分组
上面是当前模型广场的示例。可用模型取决于你的 API Key 分组;价格按模型广场实时显示,本站不在本文固定展示价格。
打开模型广场查看实时模型与价格 ↗
07

余额与充值

调用费用从站内账户余额扣除,余额与模型费率按人民币展示。

1
查看钱包余额

登录后打开 钱包,确认可用余额。

2
按页面提示购买或兑换充值卡

在钱包页面使用站点提供的充值入口或卡密兑换功能;购买前核对金额和适用规则。

3
检查使用记录

请求用量与扣费明细可在控制台使用日志中查看。

请仅在站点钱包页面显示的官方入口购买或兑换,不要向个人账户转账,也不要在聊天中发送卡密。
08

密钥安全

将 API Key 当作密码处理,限制其存放和使用范围。

建议说明
使用环境变量避免把密钥硬编码在源码、前端页面或公共仓库中。
区分环境开发、测试和生产环境分别使用不同密钥。
不要分享密钥客服排查时只提供请求 ID 和错误信息,移除 Authorization 等敏感头。
及时轮换发现泄露或异常调用后,停用旧密钥并创建新密钥。
09

常见问题

先核对地址、密钥、模型权限和账户余额。

返回 401 / Unauthorized

确认请求头使用 Authorization: Bearer ...,检查密钥是否正确、未被停用,且没有复制多余空格。

返回 403 / 无权限

该模型可能不属于此密钥绑定的分组,或账户状态受限。检查 Key 分组与模型广场的可用范围。

返回 404 / 模型不存在

核对模型 ID 拼写,并使用模型广场中当前显示的名称;模型名称可能调整。

余额不足或扣费异常

检查钱包余额、模型实时费率与使用日志。如需支持,请从账户页面联系站点运营方,并避免发送 API Key。

请求超时或服务不可用

查看 服务状态页。若状态正常,可检查本地网络、超时设置和请求大小。

© 2026 Codex API · 返回站点 · 服务状态
模型、费率、可用端点及钱包规则以控制台实时信息为准。
10

CC Switch 接入教程

用 CC Switch 将 Codex CLI 或 Codex 桌面版连接到本站。

  1. 从 CC Switch 官方发布页下载适合系统的版本。在本站控制台创建 API Key,选择有目标模型权限的分组。
  2. 打开 CC Switch,选择顶部的 Codex,点击 + → 自定义。供应商名称填 Codex API,API Key 填刚创建的本站密钥。
  3. 请求地址(Base URL)填写 https://codex-api1.com/v1。默认模型填写你的密钥可用的完整模型 ID,可在本站模型列表或 GET /v1/models 的返回结果里查询。
  4. 在高级选项里选择上游格式。模型支持 /v1/responses 时选 Responses。模型仅支持 /v1/chat/completions 时,选 Chat Completions 并开启 CC Switch 的本地路由及 Codex 路由。
  5. 保存后,将 Codex API 切换为当前供应商。重新启动 Codex,发送一条简短消息,然后到本站的调用日志确认请求和模型。

遇到 401 时检查密钥和分组权限。遇到 404 时检查 Base URL 是否重复填写了 /v1 或附带了完整接口路径,再核对模型 ID 和上游格式。通过本地路由接入时,请保持 CC Switch 的路由服务运行。

CC Switch 官方路由说明

11

OpenClaw 接入教程

将本站添加为 OpenClaw 的自定义模型供应商。

  1. 在本站创建 API Key,确认分组有目标模型权限。在运行 OpenClaw Gateway 的机器上设置环境变量 CODEX_API_KEY,让 Gateway 进程能够读取它。
  2. 把以下字段合并到 ~/.openclaw/openclaw.json。已有的 models 和 agents 配置应合并到原有对象中。两处 YOUR_MODEL_ID 都替换为本站返回的同一个完整模型 ID。
{
  "models": {
    "mode": "merge",
    "providers": {
      "codex-api": {
        "baseUrl": "https://codex-api1.com/v1",
        "apiKey": "${CODEX_API_KEY}",
        "api": "openai-completions",
        "models": [{ "id": "YOUR_MODEL_ID", "name": "Codex API" }]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": { "primary": "codex-api/YOUR_MODEL_ID" }
    }
  }
}

保存后运行 openclaw gateway restart(如果 Gateway 由其他方式启动,按原方式重启)。运行 openclaw models list,确认出现 codex-api/YOUR_MODEL_ID。新建对话,发送一条简短消息,并在本站调用日志核对请求。

OpenClaw 官方自定义供应商文档

12

Hermes Agent 接入教程

通过自定义 OpenAI 兼容端点配置本站模型。

  1. 在本站创建 API Key,选择有目标模型权限的分组。
  2. 在运行 Hermes Agent 的终端执行 hermes model,选择 Custom endpoint。
  3. API Base URL 填 https://codex-api1.com/v1,API Key 填本站密钥,Model name 填你的密钥有权调用的完整模型 ID。
  4. 完成向导后运行 hermes,发送一条简短消息,再到本站调用日志确认请求和模型。若已运行 Hermes Gateway,请重启该服务以加载更新后的配置。

两套配置均使用 Chat Completions。若返回 401,检查密钥及其分组。若返回 404,核对模型 ID 和 Base URL,地址末尾保留 /v1 即可。需要调用工具时,请确认所选模型和渠道支持工具调用。

Hermes Agent 官方供应商文档