Skip to content

OpenAPI 定义 ​

Codex Relay 提供一份仅包含公开 OpenAI 兼容端点的 OpenAPI 规范,可导入 Apifox、Postman 或其他支持 OpenAPI 3.1 的工具。

下载 ​

下载 openapi.yaml

导入 Apifox ​

  1. 新建或打开一个项目。
  2. 选择导入 OpenAPI 文件或 URL。
  3. 使用 https://doc.codexapi.asia/openapi.yaml。
  4. 建立生产环境,Base URL 设置为 https://codexapi.asia。
  5. 在本地环境变量中设置 API Key,不要把真实 Key 发布到在线文档。

规范范围 ​

该文件只描述用户公开的 OpenAI 模型调用端点,不包含其他协议、后台管理、账号池、代理、用户管理或运维接口。

模型列表和部分能力会随分组动态变化,因此 model 使用字符串而不是静态枚举。调用前仍应请求 /v1/models。