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 ​