エラーハンドリング
API は標準の HTTP ステータスコードを使用し、RFC 7807 Problem Details 形式でエラーを返します。
エラーレスポンスのフォーマット
{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing API key.",
"instance": "/v1/feed"
}
| フィールド | 説明 |
|---|---|
type | エラータイプの URI(現在は about:blank) |
title | 人間が読める短い概要 |
status | HTTP ステータスコード |
detail | エラーの詳細な説明 |
instance | エラーが発生したリクエストパス |
ステータスコード
| コード | 意味 | 対応方法 |
|---|---|---|
200 | 成功 | — |
202 | 受理(非同期処理) | イベントおよびプッシュジョブはキューに登録されます |
400 | 不正なリクエスト | リクエストパラメーターを確認してください |
401 | 認証エラー | API Key を確認してください |
402 | 使用量上限超過 | クレジット残高を確認するか、上限を引き上げてください |
403 | アクセス拒否 | API Key にこのリソースへの権限がありません |
404 | リソースが見つかりません | リクエストされたリソースが存在しません |
429 | レート制限超過 | 待機してリトライしてください(レート制限 を参照) |
500 | サーバー内部エラー | Backoff 付きでリトライしてください。継続する場合はサポートにお問い合わせください |
リトライ戦略
一時的なエラー(429、500)には、Exponential Backoff を使用してください:
wait_time = min(base_delay * 2^attempt, max_delay)
| パラメーター | 推奨値 |
|---|---|
| 基本遅延 | 1 秒 |
| 最大遅延 | 30 秒 |
| 最大リトライ回数 | 3 回 |
400、401、402、403、404 エラーはリトライ しないでください — これらはリクエストの修正が必要です。