Codex API 金鑰，為開發者說明

了解 API 金鑰格式

當您註冊提供 codex api key 的服務時，您會收到一串唯一的字母數字字串。此金鑰作為您向後端發送每個請求的驗證憑證。其格式通常遵循標準模式，例如 sk-... 或類似的前綴，具體取決於供應商的實作方式。然而，由於您使用的是獨立代理伺服器，確切的前綴可能會有所不同。關鍵因素不在於格式本身，而是確保將金鑰正確傳遞至 HTTP Authorization 標頭中，格式為 Bearer <your_key>。

您的 API 金鑰與特定帳戶和使用層級綁定。與某些為不同環境（開發與生產）產生多個金鑰的服務不同，我們的設定很簡單：一個帳戶，一個金鑰。如果您遺失金鑰或懷疑其已遭洩漏，您可以立即從您的儀表板重新產生它。這會立即撤銷舊金鑰，確保沒有未經授權的存取持續存在。請記住，每次旋轉金鑰時，都要更新您的環境變數或設定檔。

安全性最佳實踐

• 將金鑰儲存在環境變數中，而非原始碼中。
• 請勿將您的 codex api key 提交至公開儲存庫。
• 如果您懷疑金鑰已洩露，請使用重新產生功能。

常見錯誤：401 未授權

401 Unauthorized 錯誤是整合新 API 金鑰時最常遇到的問題。這表示伺服器拒絕了您的驗證憑證。在 claude code proxy 或任何 OpenAI 相容端點的脈絡下，這幾乎總是意味著金鑰遺失、不正確或已過期。

要進行故障排除，首先驗證您是否完全按照提供的方式複製金鑰。金鑰通常區分大小寫，如果複製不正確，可能包含空格。確保您使用的是適合您地區或使用層級的正确基礎 URL。如果您最近重新產生了金鑰，請確保您的客戶端使用的是新值。401 錯誤與您的使用餘額或速率限制無關；它純粹是驗證失敗。

解決檢查清單

1. 確認 API 金鑰字串與儀表板完全匹配。
2. 驗證 Authorization 標頭格式：Authorization: Bearer YOUR_KEY。
3. 檢查基礎 URL 是否適合您的帳戶類型。
4. 確保複製貼上時沒有加入額外的空白。

超過速率限制：429 錯誤

當您超過允許的請求量時，API 會傳回 429 Too Many Requests 錯誤。對於我們的服務，限制設定為每分鐘每金鑰 300 次請求。此限制是為了確保公平使用並為所有使用者維持低延遲。如果您正在進行高容量的程式碼工作階段，您可能會很快達到此限制，特別是如果您的程式碼觸發多個內部請求時。

當發生 429 錯誤時，回應通常包含一個 Retry-After 標頭，指示您應該等待多少秒後再重試。在客戶端程式碼中實作指數退避是處理這些錯誤的標準方法。與其立即重試，不如等待一小段時間，然後將後續重試的等待時間加倍。這可防止您的應用程式在限制重置前淹沒伺服器。

值得注意的是，速率限制是針對金鑰而非帳戶。如果您有多個裝置或程序使用相同金鑰，它們共享每分鐘 300 次請求的配額。如果您需要更高的總吞吐量，請考慮為不同環境使用不同的金鑰。

正確設定基礎 URL

基礎 URL 是任何 API 整合的基礎。對於 OpenAI 相容服務，基礎 URL 決定您的請求傳送至何處。我們的基礎 URL 是 https://api.claudecodeapikey.com/v1。在發出任何請求之前，必須在您的客戶端程式庫或 SDK 中設定此 URL。如果您使用錯誤的基礎 URL，您將收到連線錯誤或意外回應。

許多開發人員使用適用於 Python、Node.js 或其他語言的官方 OpenAI SDK。要切換至我們的代理伺服器，您只需更新基礎 URL 設定。例如，在 Python 中，您可能設定 base_url='https://api.claudecodeapikey.com/v1'。確保協議（https）和路徑（/v1）是正確的。省略 /v1 路徑是一個常見錯誤，會導致 404 錯誤。

始終驗證您的客戶端是否將請求傳送至正確的端點。您可以透過檢查網路日誌或使用 curl 等工具來測試連線來做到這一點。成功連線至基礎 URL 確認您的設定是正確的。

處理串流輸出回應

串流輸出允許您在 API 回應產生時接收部分回應，而不是等待整個回應完成。這對於即時顯示程式碼片段的程式碼代理至關重要。我們的 API 支援透過伺服器發送事件 (SSE) 進行串流輸出。當您在客戶端啟用串流輸出時，您將收到一個資料片段串流，每個片段包含部分回應。

要啟用串流輸出，請在請求中將 stream 參數設定為 true。客戶端程式庫將自動處理 SSE 協議。您可以處理每個到達的片段，更新您的 UI 或記錄進度。這提供了更好的使用者體驗，特別是對於長程式碼生成。

串流輸出不會改變底層模型或其功能。它純粹是一種傳輸機制。模型仍然處理整個提示詞並生成完整的回應；差異在於輸出如何傳送至您的客戶端。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.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)

工具呼叫設定問題

工具呼叫（或函式呼叫）允許 LLM 請求特定動作，例如執行程式碼片段或查詢資料庫。我們的 API 支援工具呼叫，這意味著您可以在請求中定義函式，並從模型接收結構化的 JSON 回應。這對於需要與外部系統互動的高階程式碼代理至關重要。

要設定工具呼叫，您必須在 tools 參數中提供函式定義列表。每個工具都應具有名稱、描述和參數架構。然後模型將根據提示詞決定何時呼叫工具。如果模型決定呼叫工具，回應將包含一個 tool_calls 陣列，其中包含函式名稱和參數。

常見問題出於不正確的 JSON 架構定義。確保您的參數類型和必要欄位已準確指定。如果架構無效，模型可能無法正確呼叫工具。使用簡單的提示詞測試您的工具定義，以驗證模型是否了解預期的行為。

上下文視窗限制

上下文視窗定義模型在單一請求中可以處理的最大文字量，包括提示詞（輸入）和補全（輸出）。我們的模型具有 100,000 token 的上下文視窗。這是大量的文字，但並非無限。如果您的提示詞加上預期的輸出超過此限制，API 將傳回錯誤。

要有效管理上下文，請監控提示詞的 token 使用量。長檔案或廣泛的對話歷史可能會迅速消耗可用的 token。如果您接近限制，請考慮截斷較舊的訊息或摘要之前的互動。某些客戶端會自動透過滑動視窗來處理此問題，但最好了解限制以避免意外錯誤。

請記住，上下文視窗包含傳送至模型的所有 token，包括系統訊息、使用者訊息和助手訊息。請相應地規劃您的 token 配額，以確保在長程式碼工作期間順利運作。

重新產生您的金鑰

重新產生 API 金鑰是一個簡單的流程，可確保安全性。如果你懷疑金鑰已外洩，或想定期輪換憑證，可以從你的儀表板產生新的金鑰。舊金鑰會立即失效，因此使用舊金鑰的進行中請求將會失敗。

重新產生金鑰時，請務必在所有用戶端和設定檔中更新新值。這包括環境變數、設定檔以及程式碼中的任何硬編碼值。若未在所有位置進行更新，可能會導致應用程式的部分功能出現驗證錯誤。

我們的服務允許無限次重新產生金鑰。頻繁輪換金鑰不會有任何懲罰。這是維持安全性的良好做法，特別是在共用環境中，或將金鑰分發給團隊成員時。

Copycurl https://api.claudecodeapikey.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."}]
  }'