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 以幫助我們快速解決您的問題。