エラー
エラーは RFC 7807 Problem Details 形式で返ります。HTTP status だけでなく、機械可読な code を見て処理してください。
レスポンス例
{
"type": "https://api.momongasearch.com/errors/content-not-available",
"title": "Content not available",
"status": 409,
"code": "content_not_available",
"detail": "This document content is pending release.",
"document_id": "doc_...",
"content_status": "pending_release",
"retry_after_seconds": 3600
}
代表的な code
| code | HTTP status | 意味 |
|---|---|---|
authentication_required | 401 | Authorization ヘッダーがない |
invalid_api_key | 401 | API キーが無効 |
not_found | 404 | 指定したリソースが存在しない |
content_not_available | 409 | 本文・目次が取得できない |
image_not_available | 409 | ページ画像が取得できない |
rate_limit_exceeded | 429 | レート制限を超過 |
quota_exceeded | 429 | quota を超過 |
rate_limit_exceeded は、API key 単位の RPM に達した場合に返ります。短時間の burst には追加制限が適用される場合があります。Retry-After と X-RateLimit-Reset を見て再試行してください。
quota_exceeded は、日次 catalog quota や月次 compute units など、明示 quota を使い切った場合に返ります。plan ごとの上限は Pricing を参照してください。
image_not_available は、指定ページが文書の page_count 範囲内だが GET /v1/documents/{document_id}/page-images に含まれない場合に返ります。存在しない文書や範囲外ページは not_found です。
未知の code は generic error として扱い、クライアントが落ちないようにしてください。