API リファレンス（基本）

この機能でできること

AI BOOTH を「他のシステムから自動で操作する」ための窓口（API）の一覧です。

「API」とは「他のプログラムから命令を出して動かす入口」のことです。たとえば、自社の予約システムから AI BOOTH にチャット履歴を取りに行く、CRM から FAQ を一括登録する、といった連携ができます。

このページはエンジニア向けの内容です。実際の連携作業は社内 IT 担当者やシステム業者にこの URL を共有してください。

用語解説

ステップ 1: API キーを発行する

1-1. 管理画面で API キーを作成

1. AI BOOTH の管理画面で /admin/settings を開く
2. 「API」タブをクリック
3. 「+ 新しい API キーを発行」をクリック
4. キーの名前（例：「予約システム連携」）と権限（読み取り専用 / 書き込み可）を選択
5. 「発行」をクリック

1-2. キーを安全に保管

発行画面に表示される文字列（scb_live_xxxxxxxxxxxx）が API キーです。

• 画面を閉じると二度と表示されません。すぐにパスワードマネージャーや社内シークレット管理に保存
• メール・チャットで送信しない
• ソースコードに直接書かない（環境変数に入れる）

ステップ 2: API の基本仕様

認証ヘッダーの書き方

Authorization: Bearer scb_live_xxxxxxxxxxxx
Content-Type: application/json

ステップ 3: 主要エンドポイント一覧

チャット関連

エージェント関連

知識ベース関連

ユーザー関連

集計・分析

Webhook

ステップ 4: 試しに呼んでみる（curl 例）

エージェント一覧を取得する例：

curl -X GET https://api.aibooth.app/v1/agents \
  -H "Authorization: Bearer scb_live_xxxxxxxxxxxx"

成功すると以下のような JSON が返ります：

{
  "data": [
    {
      "id": "agent_abc123",
      "name": "金沢店コンシェルジュ",
      "created_at": "2026-05-01T00:00:00Z"
    }
  ]
}

ステップ 5: エラーコード一覧

ステップ 6: Webhook で AI BOOTH からの通知を受け取る

「新しいチャットが発生したら自社システムに通知する」といった用途で使えます。

6-1. Webhook を登録

1. /admin/settings → 「Webhook」タブ
2. 「+ 新規 Webhook」をクリック
3. 通知先 URL（自社サーバーの URL）を入力
4. 通知したいイベント（chat.started / chat.completed / 👎 など）を選択
5. 「保存」をクリック

6-2. 検証署名

すべての Webhook には X-AIBOOTH-Signature ヘッダーが付きます。HMAC-SHA256 でペイロード検証してください。

ステップ 7: API キーの管理

漏洩疑いがある場合は 即座に無効化 してください。

よくある質問

それでも解決しない時

info@scirnex.com までお気軽にお問い合わせください。