エラー

すべてのエラーは、同じ JSON 本文を使います。失敗したリクエストを HTTP 200 で返すことはありません。エラーが 200 のレスポンスの中に入る 2 つの場合は、レスポンスの中のエラーで説明します。

{
  "error": {
    "message": "Model \"example/unknown\" was not found.",
    "type": "not_found_error",
    "code": "model_not_found",
    "param": "model",
    "request_id": "req_0123456789abcdef0123456789abcdef",
    "doc_url": "https://example.com/docs/errors/#model_not_found"
  }
}

• message: 人が読む短い説明です。
• type: エラーの分類です。
• code: プログラムが使う安定した識別子です。分岐には message ではなく code を使ってください。
• param: エラーの原因になったリクエストパラメータです。無ければ null です。
• request_id: リクエストの ID です。サポートに問い合わせるときに控えておいてください。
• doc_url: このページにある、そのコードの項目へのリンクです。
• details: 任意の機械可読な補足です。入るフィールドはエラーによって異なります。
  • 指定できる値が決まっているフィールドでは、details.allowed に指定できる値が入ります。
  • 数値が範囲外のときは、details.minimum と details.maximum に許容範囲が入ります。
  • 402 では、details.limit_source に balance か key が入ります。ほかのフィールドには金額が入り、キーの利用上限では期間と details.resets_at も入ります。残高とキーの利用上限を参照してください。
  • 使えない参照画像の URL では、details.reason にその理由が入ります。
  • data URI で送った参照画像が大きすぎるときは、details.max_bytes に上限が入ります。
  • payload_too_large では、details.max_bytes に上限が入ります。
  • ジョブの完了を待っていたリクエストが、そのジョブの失敗で失敗したときは、details.job_id にジョブの ID が入ります。
  • 終わったジョブのキャンセルや、ファイルのない動画のダウンロードのように、ジョブのステータスによってリクエストが失敗したときは、details.status にジョブのステータスが入ります。

次の 2 つの場合は、200 のレスポンスの中でエラーを知らせます。

• 始まったあとに失敗したチャットのストリーミングのレスポンス。エラーは、ストリームの中のイベントとして届きます。チャットを参照してください。
• 失敗したジョブ。ジョブを読み取ると 200 を返し、ジョブの error フィールドに、エラーのレスポンスと同じフィールドが入ります。ジョブを参照してください。

POST /v1/messages は、すべてのエラーを Anthropic 形式で返します。type は error で、エラーの内容は error に入り、request_id はトップレベルのフィールドです。コードと HTTP ステータスは、下の表と同じです。チャットを参照してください。

各コードはその行へのリンクになっているため、doc_url のアンカー（#<code>）で対応する項目が開きます。