ドキュメント/エラー処理

エラー処理

APIのエラーはすべて一貫した形式で返されます。適切に処理する方法をご紹介します。

Markdownを表示 OpenAPI JSON

エラーレスポンスの形式

エラーが発生すると、APIは次の構造のJSONオブジェクトを返します:

json
{
  "error": "Validation Error",
  "message": "The email field is required.",
  "status_code": 422
}

エラーコード

ステータスコードエラー原因と対処法
400 Bad Request JSONの形式が不正か、必須フィールドが不足しています。リクエスト本文を確認してください。
401 Unauthorized APIキーが未指定または無効です。Authorizationヘッダーを確認してください。
402 Payment Required クレジットが不足しています。クレジットを追加購入するか、1日の上限がリセットされるまでお待ちください。
422 Validation Error メールアドレスの形式が無効です。送信している値を確認してください。
429 Too Many Requests レート制限を超えました。Retry-Afterヘッダーを確認し、指定された時間だけ待ってください。
500 Internal Server Error 当社側で問題が発生しました。数秒後に再度お試しください。失敗が続く場合はサポートにお問い合わせください。

401 Unauthorized

json
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "status_code": 401
}

対処法:お使いのAuthorizationヘッダーが次の形式になっているか確認してください:Bearer YOUR_API_KEY。ダッシュボードでキーを確認してください。

422 Validation Error

json
{
  "error": "Validation Error",
  "message": "The email field must be a valid email address.",
  "status_code": 422
}

対処法: emailの値が有効なメール形式であることを確認してください(例:user@example.com)。送信前に入力をクリーニングしてください。

429 Too Many Requests

json
{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please slow down.",
  "status_code": 429,
  "retry_after": 15
}

対処法:指定された秒数(retry_after)待ってから再試行してください。詳しくはレート制限 →

トラブルシューティングのチェックリスト