APIの使用
エラー
APIエラーとエラー処理に関する包括的なガイド
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
オブジェクトには必ずtype
とmessage
の値が含まれます。例:
JSON
当社のバージョニングポリシーに従い、これらのオブジェクト内の値を拡張する可能性があり、type
の値は時間とともに増える可能性があります。
リクエストID
すべてのAPIレスポンスには、一意のrequest-id
ヘッダーが含まれています。このヘッダーにはreq_018EeWyXxfu5pfWkrYcMdjWG
のような値が含まれています。特定のリクエストについてサポートに問い合わせる際は、問題を迅速に解決できるよう、このIDを含めてください。
公式SDKsでは、この値はx-request-id
ヘッダーの値を含むトップレベルのレスポンスオブジェクトのプロパティとして提供されます: