OpenAI API 快速开始

CODEX RELAY / OPENAI GATEWAY

一套 Key 接入 OpenAI Responses、Chat Completions、Embeddings 与 Images。按照本页操作，你可以在几分钟内完成模型查询和第一次请求。

OpenAI CompatibleResponses FirstDEV-0807

API Base URLhttps://codexapi.asia

POSTResponses API/v1/responsesCodex 与新式 OpenAI 客户端的首选接口 POSTChat Completions/v1/chat/completions兼容常见聊天、IDE 与桌面客户端 POSTEmbeddings/v1/embeddings向量化、检索与知识库工作流 POSTImages API/v1/images/generations图像生成、编辑与 Base64 结果处理

1. 创建 API Key

登录控制台

打开 Codex Relay 控制台。如当前开放注册，请先完成注册与登录。

进入 API Key 页面

新建一个 Key，选择公开所需 OpenAI 模型的分组，并设置便于识别的名称。

立即保存

Key 应视为密码。不要发到聊天记录、截图、前端代码或公开仓库。

2. 查询可用模型

将 YOUR_API_KEY 替换成你刚创建的 Key：

bash

curl https://codexapi.asia/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

模型列表由 API Key 所属分组决定。客户端中的模型名必须与返回的 id 完全一致。

3. 发出第一条请求

以下示例使用 OpenAI Chat Completions 兼容接口。把 MODEL_ID 替换成上一步返回的模型：

bash

curl https://codexapi.asia/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_ID",
    "messages": [
      {"role": "user", "content": "Say hello in one sentence."}
    ],
    "stream": false
  }'

Base URL 怎么填

软件要求填写 API Host/Base URL 时，通常填 https://codexapi.asia。
OpenAI SDK 要求填写 base_url 时，通常填 https://codexapi.asia/v1。
不要让客户端最终拼成 /v1/v1/...。

下一步

接入 CodexCodex++ 与 config.toml 配置 使用 OpenAI SDKPython、Node.js 与 curl 示例 配置常用客户端OpenAI Compatible Provider 通用参数 请求失败401、404、429、503 和空白图片排查

相关资源

OpenAI API 快速开始 ​

1. 创建 API Key ​