エラー - Admina Help Center

HTTP ステータスコード

API は標準的な HTTP ステータスコードを使用します。AI Helpdesk API はリードオンリーのため、2xx 系では 200 のみを返します。

ステータスコード	意味	説明
200	OK	リクエストが成功した
400	Bad Request	クエリパラメータが不正、または必要な設定が欠落している
401	Unauthorized	`X-API-Key` ヘッダーが欠落しているか無効
404	Not Found	指定したリソースが存在しない

エラーが発生した場合、API は以下の形式の JSON レスポンスを返します。

{
  "ok": false,
  "error": "Missing or invalid API key"
}

フィールド	型	説明
`ok`	boolean	エラー時は `false`
`error`	string	人間が読めるエラーメッセージ

{
  "ok": false,
  "error": "Missing or invalid API key"
}

原因: X-API-Key ヘッダーが設定されていない、または値が無効。

{
  "ok": false,
  "error": "Not found"
}

原因: パスパラメータ（sessionKey、docId、typePath、integrationId など）が存在しないか、別テナントに属している。

{
  "ok": false,
  "error": "Invalid query parameters"
}

原因: status や assigneeType などの enum パラメータに範囲外の値を指定した、limit が 1..100（procedures は 1..500）の範囲外、など。