HTTP錯誤

我們的API遵循可預測的HTTP錯誤代碼格式:

  • 400 - invalid_request_error:您的請求格式或內容有問題。我們也可能將此錯誤類型用於下面未列出的其他4XX狀態代碼。
  • 401 - authentication_error:您的API金鑰有問題。
  • 403 - permission_error:您的API金鑰沒有使用指定資源的權限。
  • 404 - not_found_error:找不到請求的資源。
  • 413 - request_too_large:請求超過允許的最大位元組數。
  • 429 - rate_limit_error:您的帳戶已達到速率限制。
  • 500 - api_error:Anthropic系統內部發生意外錯誤。
  • 529 - overloaded_error:Anthropic的API暫時超載。

當通過SSE接收串流回應時,可能會在返回200回應後發生錯誤,在這種情況下,錯誤處理將不會遵循這些標準機制。

錯誤格式

錯誤始終以JSON格式返回,頂層error物件始終包含typemessage值。例如:

JSON
{
  "type": "error",
  "error": {
    "type": "not_found_error",
    "message": "The requested resource could not be found."
  }
}

根據我們的版本控制政策,我們可能會擴展這些物件中的值,並且type值可能會隨時間增加。

請求ID

每個API回應都包含一個唯一的request-id標頭。此標頭包含諸如req_018EeWyXxfu5pfWkrYcMdjWG之類的值。當就特定請求聯繫支援時,請包含此ID以幫助我們快速解決您的問題。

我們的官方SDK將此值作為頂層回應物件的屬性提供,包含x-request-id標頭的值:

Was this page helpful?