概要

Quickchat AI プラットフォームの REST API リファレンス — 認証、ベース URL、レート制限、ページネーション、エラーハンドリング。

Quickchat AI は、AI Agent の設定、Knowledge Base、Conversations、AI Actions などにプログラムからアクセスするための REST API を提供しています。

Authentication

すべての API エンドポイントは Bearer トークン認証を使用します。すべてのリクエストの Authorization ヘッダーに API トークンを含めてください：

Authorization: Bearer <API_TOKEN>

トークンは Quickchat Dashboard の External Apps > API で作成します。各トークンは scenario_id を含む JWT であるため、追加の識別子ヘッダーは不要です。

トークン有効期間：作成から 52 週間
トークンは Dashboard からいつでも 無効化 できます
各トークンは単一の AI Agent（シナリオ）にスコープされます
トークンの作成には Business プラン以上が必要です。下位のプランではこのオプションは無効化され、エンドポイントは 402 Payment Required を返します

API トークンは次の 2 つのスコープのいずれかで作成されます：

Scope	Access Level	Description
`read_all`	Read-only	すべてのリソースを読み取れますが、作成・更新・削除はできません
`write_all`	Read + Write	書き込み操作を含む、すべてのエンドポイントへのフルアクセス

トークンは、Dashboard の External Apps > API で作成する際にスコープが割り当てられます
write_all スコープには、すべての read_all 権限が自動的に含まれます
read_all トークンを書き込みエンドポイントで使用すると、"Insufficient token scope. Required: write_all" とともに 403 が返されます

エンドポイントグループごとのスコープ要件:

Endpoint Group	Base URL
Knowledge Base, AI Actions, File Upload, Import, Chatbot Settings, Widget, Handoff, Conversation Rating	`https://app.quickchat.ai/v1/api/`
Conversations	`https://app.quickchat.ai/v1/api_core/`
Realtime Chat	`https://app.quickchat.ai/chat`

レート制限はトークンごと、エンドポイントごとに適用されます。

レート制限を超過すると、API は HTTP 429 Too Many Requests を返します。

リストエンドポイントはクエリパラメータによるページネーションをサポートしています：

Parameter	Description
`limit` integer	1 ページあたりのアイテム数
`offset` integer	スキップするアイテム数

ページネーションのレスポンスは次の構造に従います：

{
  "items": [],
  "offset": 0,
  "limit": 10,
  "count": 100
}

すべてのエラーは次の形式の JSON で返されます：

{
  "errors": {
    "root": [
      {
        "message": "Description of the error",
        "code": "ERROR_CODE"
      }
    ]
  }
}

最終更新日: 2026/07/09