Base URL 和身份驗證
我們的 API 遵循標準的 OpenAI chat-completions 介面。要進行整合，請使用我們特定的 base URL 和有效的 codex api 金鑰更新您的客戶端配置。您可以在儀表板註冊期間生成此金鑰。該端點接受標準和串流請求，使其成為大多數期望 OpenAI 相容結構的編碼代理的即插即用替代品。
驗證依賴 Authorization 標頭。將金鑰作為 Bearer token 包含在內。若使用代理伺服器或自訂代理框架，請確保其遵循標準 HTTP 標頭。該服務獨立運作；不經其他供應商路由或聚合模型。你直接連接到我們的無審查 LLM。
發送聊天補全
首先測試簡單的文本請求。這可以確認您的身份驗證和 base URL 是否正確。該端點接受具有 user 或 assistant 等角色的消息列表。model id 始終為 uncensored。此請求返回標準的補全響應。在轉向複雜提示詞之前，使用此方法驗證您的代理是否可以解析 JSON 結構。
確保您的 payload 保持在 8 MB 的主體限制內。支援大的上下文視窗，但總 token 計數（輸入加輸出）必須保持在 100,000 token 以下。如果您超過這些限制，伺服器將返回錯誤。從小測試開始以確認連接性。
curl https://api.getcodexapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
}'啟用串流輸出 (SSE)
對於需要即時 token 生成的編碼代理，請啟用串流輸出。在請求主體中將 stream 參數設置為 true。伺服器返回 Server-Sent Events (SSE) 序列，而不是單個 JSON 對象。每個事件包含響應的部分塊。這降低了用戶的感知延遲，並允許您的代理在 token 到達時處理它們。
串流輸出不會改變定價或 token 計數。您仍然為總輸入和輸出 token 付費。在您的客戶端代碼中處理 SSE 串流以累積最終響應或增量處理。這對於中間結果有用的代碼生成非常理想。
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)使用函式呼叫
我們的模型支援函式呼叫，允許您的代理執行外部工具。在 tools 參數中定義您的函式。如果模型確定需要函式，它將返回帶有函式呼叫的響應，而不是純文本。您的代理必須解析此響應並執行該工具，然後將結果反饋到對話中。
此功能對於需要運行代碼、查詢數據庫或獲取實時數據的編碼代理至關重要。工具架構遵循標準的 OpenAI 格式。確保您的代理正確處理模型和您的工具執行邏輯之間的往返。這通過用結構化的工具結果替換原始文本來有效地保持上下文視窗。
from openai import OpenAI
client = OpenAI(base_url="https://api.getcodexapi.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)檢查可用模型
使用 GET /v1/models 端點來驗證可用模型。此端點返回模型對象列表，包括它們的 ID 和創建日期。我們的 API 提供單一模型：uncensored。與聚合多個供應商的代理中繼不同，我們為一個優化的 LLM 提供專用端點。這確保了一致的行為和可預測的性能，以滿足您的編碼任務。
查詢此端點以確認您的客戶端已連接到正確的服務。它返回標準的元數據字段。您不需要手動管理模型選擇。客戶端只需在所有聊天補全中請求 uncensored model ID。這簡化了整合並避免了路由錯誤。
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.getcodexapi.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);速率限制和約束
監控您的使用情況以避免中斷。API 對每個金鑰實施每分鐘 300 次請求的限制。如果您超過此限制，您將收到 429 Too Many Requests 錯誤。請求主體大小限制為 8 MB。這些約束確保了高吞吐量代理的穩定性能。如果您正在處理大型批次，請調整客戶端的請求頻率。
若金鑰無效，驗證錯誤會傳回 401 狀態碼。額度不足則會傳回 402 狀態碼。發送請求前，請確保您的預付餘額為正數。額度永不過期，因此您可以隨時儲值。codex api 金鑰可隨時重新產生，舊金鑰將立即失效。請妥善保管您的金鑰。
