エラーの形式
エラーはこの形式の JSON です。決して変わらない code で分岐してください。message は人が読むためのもので、変わることがあります。400 では details に無効なフィールドがすべて列挙されます。
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}コード
コード名をアンカーにすると、そのコードに直接リンクできます。例：/docs/api/errors#rate_limited
- 400invalid_request
- ボディ、クエリ、またはヘッダーが無効です。details に問題のあるフィールドがすべて示されます。リクエストを修正してください。そのまま再送しても再び失敗します。
- 401api_key_expired
- キーの有効期限が切れています。新しいキーを作成するか、キーを再発行して新しいシークレットを取得してください。
- 401api_key_revoked
- キーは無効化されています。設定 › 開発者 で新しいキーを作成してください。
- 401invalid_api_key
- 一致するキーがありません。キー全体がコピーされているか確認するか、設定 › 開発者 で新しいキーを作成してください。
- 402insufficient_credits
- キー所有者の AI クレジットがなくなりました。Attorly でチャージまたはアップグレードしてから、もう一度お試しください。
- 402usage_limit_exceeded
- キー所有者または組織の AI 使用上限に達しました。請求期間とともにリセットされます。組織の管理者はメンバーの上限を引き上げられます。
- 403ai_consent_withdrawn
- キーの所有者またはドキュメントの所有者が AI 処理への同意を撤回しています。同意はプライバシー設定で再度行えます。
- 403forbidden
- キーはリソースを読み取れますが変更できないか、その操作は許可されていません。所有者に編集権限を依頼してください。
- 403insufficient_scope
- この操作に必要な権限がキーにありません。メッセージにその権限が示されます。その権限を含むキーを作成してください。
- 403ip_not_allowed
- キーに IP 許可リストが設定されており、リクエストがリスト外のアドレスから送られました。許可されたアドレスから呼び出すか、設定 › 開発者 でリストを変更してください。
- 403plan_required
- キー所有者のプランに API アクセスが含まれていないか、所有者が組織を離れています。API アクセスには Pro または Enterprise が必要です。
- 404not_found
- リソースが存在しないか、このキーからは見えません。ID と、キー所有者にアクセス権があるかを確認してください。
- 405method_not_allowed
- このパスはこの HTTP メソッドに対応していません。Allow ヘッダーに対応するメソッドが列挙されます。
- 409conflict
- リクエストがリソースの現在の状態と矛盾しています（すでに実行済みの操作など）。リソースを読み直してから判断してください。
- 409idempotency_request_in_progress
- 同じ Idempotency-Key のリクエストがまだ処理中です。Location ヘッダーをポーリングするか、Retry-After 秒後に再試行してください。
- 413payload_too_large
- ボディまたはアップロードしたファイルが大きすぎます。ファイルは 10 MB までです。
- 415unsupported_media_type
- この操作が受け付けない形式のボディです。JSON を送るか、アップロードできる場合は multipart/form-data を送ってください。
- 422idempotency_key_reused
- この Idempotency-Key は別のリクエストで使われています。異なるリクエストごとに新しいキーを使ってください。
- 422unprocessable
- リクエストは有効ですが実行できません（準拠法が選ばれていないドキュメントの分析など）。不足しているものはメッセージに示されます。
- 429concurrency_limit_exceeded
- 組織が同時に実行できる長時間 AI オペレーションの上限に達しています。いずれかが終わるまで、または Retry-After の秒数だけ待ってから再試行してください。
- 429rate_limited
- このキーが数えられるウィンドウのいずれかでリクエストが多すぎます。Retry-After の秒数だけ待ってから再試行してください。どのウィンドウが上限に達したかは RateLimit ヘッダーで分かります。
- 500internal_error
- Attorly 側で問題が発生しました。同じ Idempotency-Key で再試行してください。解決しない場合は requestId を添えてサポートにご連絡ください。
- 504timeout
- 操作が時間内に完了しませんでした。同じ Idempotency-Key で再試行するか、Prefer: respond-async を送って操作をポーリングしてください。