ステータスコード

本ページでは、API を利用して MaiAgent サービスと連携する際に、状況に応じて返される HTTP コードとレスポンス形式の例についてご説明します

API 経由で HTTP リクエストを送信する際は、以下のステータスコードを参照して、API リクエストが成功したかどうかを確認できます。

ステータスコードの説明

正常コード

ステータスコード	説明
200	リクエスト成功
201	リソースの作成成功

正常レスポンスの例

こちらは内容のサンプルです。エンドポイントによってレスポンス形式が異なる場合がありますので、該当エンドポイントのドキュメントを優先してご参照ください

{
  "count": "integer",
  "next": "string|null",
  "previous": "string|null",
  "results": [
    // 結果のレスポンス内容
  ]
}

エラーコード

ステータスコード	説明
400	リクエスト形式エラー
401	認証失敗
403	権限不足
404	リソースが存在しない
500	サーバーエラー

エラーレスポンスの例

400 - リクエストエラー：必須項目の欠落

{
  "files": ["This field is required."],
  "filename": ["This field is required."],
  "file": ["This field is required."]
}