コンテンツにスキップ
Quickchat AI Documentation

API

最終更新日:

Quickchat AI は、AI アシスタントのナレッジベース、会話、AI アクションなどにプログラムからアクセスするための REST API を提供しています。

認証

Section titled “認証”

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

Authorization: Bearer <API_TOKEN>

トークンは Quickchat ダッシュボード の Integrations > API で作成できます。各トークンは scenario_id を含む JWT であるため、追加の識別子ヘッダーは不要です。

  • トークン有効期間：作成から 52 週間
  • トークンはダッシュボードからいつでも 無効化 できます
  • 各トークンは単一の AI アシスタント（シナリオ）にスコープされます

ベース URL

Section titled “ベース URL”
Endpoint GroupBase URL
Knowledge Base, AI Actions, File Upload, Importhttps://app.quickchat.ai/v1/api/
Conversationshttps://app.quickchat.ai/v1/api_core/
Chat (Legacy)https://chat.quickchat.ai/

レート制限

Section titled “レート制限”

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

TierLimitApplies To
READ120 requests/minGET およびリスト操作
WRITE60 requests/minPOST、PATCH、PUT、DELETE
HEAVY20 requests/minファイルアップロード、インポート、スクレイピング

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

ページネーション

Section titled “ページネーション”

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

ParameterTypeDescription
limitinteger1 ページあたりのアイテム数
offsetintegerスキップするアイテム数

ページネーションレスポンスの構造は以下の通りです：

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

エラーハンドリング

Section titled “エラーハンドリング”

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

{
  "errors": {
    "root": [
      {
        "message": "Description of the error",
        "code": "ERROR_CODE"
      }
    ]
  }
}
StatusCodeDescription
400BAD_REQUEST不正な入力または必須フィールドの欠落
401PERMISSION_DENIED無効、期限切れ、または無効化されたトークン
402PAYMENT_REQUIRED有効なサブスクリプションが必要
404NOT_FOUNDリソースが見つかりません
409CONFLICT競合する操作（例：同時変更）
422VALIDATION_ERRORリクエストボディがスキーマバリデーションに失敗
429TOO_MANY_REQUESTSレート制限超過
500UNKNOWN内部サーバーエラー
503SERVICE_UNAVAILABLE一時的な利用不可

チャット（レガシー認証）

Section titled “チャット（レガシー認証）”

Chat エンドポイントは、リクエストボディ内の api_key と scenario_id を使用するレガシー認証を使用します。Bearer トークンは 使用しません。

メッセージ送信

Section titled “メッセージ送信”

POST https://chat.quickchat.ai/chat

リクエストボディ

ParameterTypeRequiredDescription
api_keystringYesダッシュボードから取得した API キー
scenario_idstringYesAI アシスタントの ID
textstringYesユーザーの入力メッセージ
conv_idstringNo会話 ID。省略すると新しい会話を開始します
message_contextstringNoAI に渡されるメッセージごとの追加コンテキスト
client_metadataobjectNoメッセージに付与するカスタムキーバリューペア（最大 5 キー）
Terminal window
curl -X POST https://chat.quickchat.ai/chat \
  -H 'Content-Type: application/json' \
  -d '{
  "api_key": "<API_KEY>",
  "scenario_id": "<SCENARIO_ID>",
  "text": "Hello!",
  "conv_id": "abcd1234"
}'

レスポンス 200 OK

{
  "ord_number": 236,
  "conv_id": "abcd1234",
  "reply": "Hey there!"
}
FieldTypeDescription
ord_numberinteger会話内の連番メッセージ番号
conv_idstring会話識別子（会話を継続するために使用）
replystringAI アシスタントの応答

ナレッジベース

Section titled “ナレッジベース”

設定の取得

Section titled “設定の取得”

ナレッジベースの設定を取得します。

GET https://app.quickchat.ai/v1/api/knowledge_base/

Terminal window
curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "retrain_state": null
}
FieldTypeDescription
one_word_descriptionstringナレッジベースの短いラベル
short_descriptionstringAI アシスタントの目的の説明
ai_commandsarray of stringsAI へのカスタム指示
retrain_statestring or null現在のトレーニング状態

設定の更新

Section titled “設定の更新”

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

リクエストボディ

ParameterTypeRequiredDescription
one_word_descriptionstringNoナレッジベースの短いラベル
short_descriptionstringNoAI アシスタントの目的の説明
ai_commandsarray of stringsNoAI へのカスタム指示
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

レスポンス 200 OK — 更新されたナレッジベース設定を返します（設定の取得 と同じスキーマ）。

記事

Section titled “記事”

記事の作成

Section titled “記事の作成”

POST https://app.quickchat.ai/v1/api/knowledge_base/articles/

リクエストボディ

ParameterTypeRequiredDescription
contentstringYes記事の内容
typestringNo"Article"（デフォルト）または "Paragraph"
titlestringNo記事のタイトル
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "Our return policy allows returns within 30 days.",
  "title": "Return Policy"
}'

レスポンス 201 Created

{
  "id": 1234,
  "article_id": "abc-123",
  "type": "Article",
  "title": "Return Policy",
  "description": "",
  "content": "Our return policy allows returns within 30 days.",
  "state": "draft",
  "url": null,
  "parent_id": null,
  "parent_type": null,
  "shortened": false,
  "tags": [],
  "created_timestamp": "2026-01-15",
  "last_modified_timestamp": "2026-01-15"
}

記事一覧の取得

Section titled “記事一覧の取得”

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/

クエリパラメータ

ParameterTypeRequiredDescription
limitintegerNo1 ページあたりのアイテム数
offsetintegerNoスキップするアイテム数
typesstringNoタイプでフィルタ：Article、Paragraph
tagsstringNoタグでフィルタ
urlstringNoURL でフィルタ
titlestringNoタイトルでフィルタ
querystringNo内容で検索
Terminal window
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/?limit=10&offset=0' \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "items": [
    {
      "id": 1234,
      "article_id": "abc-123",
      "type": "Article",
      "title": "Return Policy",
      "description": "",
      "state": "published",
      "url": null,
      "parent_id": null,
      "parent_type": null,
      "shortened": false,
      "tags": ["policies"],
      "created_timestamp": "2026-01-15",
      "last_modified_timestamp": "2026-01-15"
    }
  ],
  "offset": 0,
  "count": 1
}

記事の取得

Section titled “記事の取得”

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

Terminal window
curl https://app.quickchat.ai/v1/api/knowledge_base/articles/1234 \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK — 記事の完全なオブジェクトを返します（記事の作成 レスポンスと同じスキーマ）。

記事の更新

Section titled “記事の更新”

PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

リクエストボディ

ParameterTypeRequiredDescription
contentstringNo更新された記事内容
titlestringNo更新されたタイトル
tagsarray of stringsNo更新されたタグ
save_modestringNo"draft"（デフォルト）または "publish"
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/1234 \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Updated Return Policy",
  "content": "Returns accepted within 60 days.",
  "save_mode": "publish"
}'

レスポンス 200 OK — 更新された記事オブジェクトを返します。

記事の削除

Section titled “記事の削除”

ID を指定して 1 つまたは複数の記事を削除します。

DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/

リクエストボディ — 記事 ID の JSON 配列。

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '[1234, 5678]'

レスポンス 200 OK

記事の検索

Section titled “記事の検索”

テキストマッチングで記事内容を検索します。

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/search

クエリパラメータ

ParameterTypeRequiredDescription
querystringYes検索クエリ
is_case_insensitivebooleanNo大文字小文字を区別しない検索（デフォルト：true）
with_title_url_and_tagsbooleanNoタイトル/URL/タグも検索対象に含める（デフォルト：true）
strict_searchbooleanNo完全一致を要求（デフォルト：false）
num_of_display_articlesintegerNo表示する記事数（デフォルト：5）
num_of_data_articlesintegerNo検索対象の記事数（デフォルト：15）
Terminal window
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/search?query=return%20policy' \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "article_snippets": [
    {
      "article_id": 1234,
      "expository_sentence": "Our return policy allows returns within 30 days.",
      "query_words_ids": [
        {"start_char": 4, "end_char": 10, "text": "return"}
      ]
    }
  ],
  "article_snapshots": {
    "items": [],
    "offset": 0,
    "count": 1
  }
}

パラグラフ一覧の取得

Section titled “パラグラフ一覧の取得”

ナレッジベース内のすべてのパラグラフ（チャンク化されたコンテンツ）を一覧表示します。

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/paragraphs

クエリパラメータ

ParameterTypeRequiredDescription
limitintegerNo1 ページあたりのアイテム数
offsetintegerNoスキップするアイテム数
querystringNo内容でフィルタ
Terminal window
curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/paragraphs?limit=10' \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "items": [
    {
      "id": 1,
      "content": "Our return policy allows returns within 30 days."
    }
  ],
  "offset": 0,
  "count": 1
}

記事の言語別 URL

Section titled “記事の言語別 URL”

記事の言語別 URL を管理します。これらの URL を使用して、記事をローカライズ版のコンテンツにリンクできます。

言語別 URL の取得

Section titled “言語別 URL の取得”

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Terminal window
curl https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "url": "https://example.com/en/return-policy"
}

言語別 URL の作成

Section titled “言語別 URL の作成”

POST https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

リクエストボディ

ParameterTypeRequiredDescription
urlstringYes言語別バージョンの URL
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"url": "https://example.com/en/return-policy"}'

レスポンス 200 OK

{
  "url": "https://example.com/en/return-policy"
}

言語別 URL の更新

Section titled “言語別 URL の更新”

PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

リクエストボディ

ParameterTypeRequiredDescription
urlstringYes更新された URL

レスポンス 200 OK — 更新された URL オブジェクトを返します。

言語別 URL の削除

Section titled “言語別 URL の削除”

DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}/lang_urls/{language}

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/1234/lang_urls/en \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

タグ

Section titled “タグ”

タグ一覧の取得

Section titled “タグ一覧の取得”

ナレッジベースの記事で使用されているすべてのタグを取得します。

GET https://app.quickchat.ai/v1/api/knowledge_base/tags/

Terminal window
curl https://app.quickchat.ai/v1/api/knowledge_base/tags/ \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

["policies", "faq", "product-info"]

ファイルアップロード

Section titled “ファイルアップロード”

ファイルをアップロードして処理し、ナレッジベースに記事として追加します。

PDF のアップロード

Section titled “PDF のアップロード”

POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/pdf

PDF ファイルをアップロードします。内容が抽出され、記事として追加されます。

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/pdf \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -F 'pdf_file=@document.pdf'

レスポンス 200 OK

{
  "status": "success",
  "message": "File processed successfully.",
  "article": {
    "id": 1234,
    "title": "document.pdf"
  }
}
FieldTypeDescription
statusstring処理状態
messagestring人間が読める結果メッセージ
articleobject作成された記事

ファイルのアップロード

Section titled “ファイルのアップロード”

POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/

対応ファイル（PDF、DOCX）をアップロードします。内容が抽出され、記事として追加されます。

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/file_upload_api/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -F 'file=@document.docx'

レスポンス 200 OK — PDF のアップロード と同じスキーマ。

外部コンテンツのインポート

Section titled “外部コンテンツのインポート”

外部ソースからナレッジベースにコンテンツをインポートします。これらのエンドポイントはコンテンツを非同期で処理します。

ウェブサイトのスクレイピング

Section titled “ウェブサイトのスクレイピング”

単一のウェブページまたはウェブサイト全体をスクレイピングしてコンテンツをインポートします。

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website

リクエストボディ

ParameterTypeRequiredDescription
urlstringYesスクレイピング対象の URL
modestringNo"individual"（デフォルト）、"site_wide"、または "individual_with_summary"
phrasesarray of stringsNo抽出するキーフレーズ
html_selectorstringNo特定コンテンツを対象とする CSS セレクタ
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/docs",
  "mode": "individual"
}'

レスポンス 200 OK

{
  "status": "success",
  "url": "https://example.com/docs",
  "article": {}
}

YouTube トランスクリプトのインポート

Section titled “YouTube トランスクリプトのインポート”

YouTube 動画のトランスクリプトをインポートします。

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube

リクエストボディ

ParameterTypeRequiredDescription
urlstringYesYouTube 動画の URL
toast_process_uuidstringYesインポートプロセス追跡用の UUID v4
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "toast_process_uuid": "550e8400-e29b-41d4-a716-446655440000"
}'

レスポンス 202 Accepted — トランスクリプトは非同期で処理されます。

サイトマップのインポート

Section titled “サイトマップのインポート”

XML サイトマップ内のすべてのリンクからコンテンツをインポートします。

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map

リクエストボディ

ParameterTypeRequiredDescription
site_mapstringYesXML サイトマップの URL
link_filter_regexstringNoインポートするリンクをフィルタする正規表現（デフォルト：".*"）
html_selectorstringNo特定コンテンツを対象とする CSS セレクタ
summarizebooleanNoインポートしたコンテンツを要約するかどうか（デフォルト：false）
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "site_map": "https://example.com/sitemap.xml"
}'

レスポンス 200 OK

{
  "status": "success",
  "links": ["https://example.com/page1", "https://example.com/page2"]
}

リンクリストのスクレイピング

Section titled “リンクリストのスクレイピング”

指定した URL リストからコンテンツをインポートします。

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list

リクエストボディ

ParameterTypeRequiredDescription
linksarray of stringsYesスクレイピング対象の URL リスト（空でないこと）
tagsarray of stringsNoインポートした記事に適用するタグ
html_selectorstringNo特定コンテンツを対象とする CSS セレクタ
summarizebooleanNoインポートしたコンテンツを要約するかどうか（デフォルト：false）
Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "links": ["https://example.com/page1", "https://example.com/page2"],
  "tags": ["imported"]
}'

レスポンス 200 OK

{
  "status": "success",
  "links": ["https://example.com/page1", "https://example.com/page2"]
}

ソース

Section titled “ソース”

外部コンテンツソース（例：Intercom、Shopify）を管理し、ナレッジベースに記事を同期します。

{source} パスパラメータは "intercom"、"shopify" などの値を受け付けます。

ソース記事のインポート

Section titled “ソース記事のインポート”

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/import

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/sources/intercom/import \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{}'

レスポンス 200 OK — インポートされた記事スナップショットのリストを返します。

ソース記事の削除

Section titled “ソース記事の削除”

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/delete

指定したソースからインポートされたすべての記事を削除します。

レスポンス 204 No Content

ソース記事の差分

Section titled “ソース記事の差分”

ローカルの記事と外部ソースを比較して変更を検出します。

POST https://app.quickchat.ai/v1/api/knowledge_base/sources/{source}/articles_diff

レスポンス 200 OK

[
  {
    "internal_article_diff": "CHANGED",
    "external_article_diff": "UNCHANGED",
    "article_snapshot": {}
  }
]
FieldTypeDescription
internal_article_diffstring"CHANGED" または "UNCHANGED"
external_article_diffstring"CHANGED"、"UNCHANGED"、または "REMOVED"
article_snapshotobject記事スナップショットデータ

Intercom ナレッジベース

Section titled “Intercom ナレッジベース”

Intercom ナレッジベース連携を管理する専用エンドポイントです。

Intercom 記事の更新

Section titled “Intercom 記事の更新”

既存の記事について Intercom からコンテンツを再取得します。

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/refresh_articles

リクエストボディ

ParameterTypeRequiredDescription
article_idsarray of integersNo更新する特定の記事 ID（デフォルト：すべて）
fetch_new_articlesbooleanNo新しい記事を取得するかどうか（デフォルト：true）

レスポンス 204 No Content

Intercom 記事のインポート

Section titled “Intercom 記事のインポート”

Intercom からすべての記事をインポートします。

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/import

レスポンス 200 OK — インポートされた記事スナップショットのリストを返します。

Intercom 記事の削除

Section titled “Intercom 記事の削除”

ナレッジベースから Intercom ソースのすべての記事を削除します。

POST https://app.quickchat.ai/v1/api/knowledge_base/intercom/delete

レスポンス 204 No Content

Intercom 記事の差分

Section titled “Intercom 記事の差分”

ローカルの記事と Intercom を比較して変更を検出します。

GET https://app.quickchat.ai/v1/api/knowledge_base/intercom/articles_diff

Terminal window
curl https://app.quickchat.ai/v1/api/knowledge_base/intercom/articles_diff \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK — 記事差分オブジェクトのリストを返します（ソース記事の差分 と同じスキーマ）。

会話

Section titled “会話”

会話一覧の取得

Section titled “会話一覧の取得”

GET https://app.quickchat.ai/v1/api_core/conversations

クエリパラメータ

ParameterTypeRequiredDescription
limitintegerNo1 ページあたりのアイテム数
offsetintegerNoスキップするアイテム数
querystringNo注文番号、UUID、またはメッセージテキストで検索
assignee_typestringNo"ai_assistant"、"human_operator"、または "unassigned"
sourcestringNo"widget"、"slack"、"telegram"、"whatsapp" など
resolution_statusstringNo"open" または "resolved"
created_timestamp_start_datedatetimeNo作成日でフィルタ（開始）
created_timestamp_end_datedatetimeNo作成日でフィルタ（終了）
last_message_at_start_datedatetimeNo最終メッセージ日でフィルタ（開始）
last_message_at_end_datedatetimeNo最終メッセージ日でフィルタ（終了）
most_frequent_languagestringNo検出された言語でフィルタ
Terminal window
curl 'https://app.quickchat.ai/v1/api_core/conversations?limit=10&resolution_status=open' \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "items": [
    {
      "id": "conv-uuid-1234",
      "ord": 42,
      "created_at": "2026-01-15T10:30:00Z",
      "last_message_at": "2026-01-15T10:35:00Z",
      "title": "Return policy question",
      "source": "widget",
      "terminated": false,
      "resolution_status": "open",
      "has_unread_messages": true,
      "assignee": {
        "type": "ai_assistant"
      },
      "visitor_name": "John",
      "visitor_email": "john@example.com",
      "visitor_phone_number": null,
      "visitor_label": null
    }
  ],
  "offset": 0,
  "count": 42
}

会話の詳細取得

Section titled “会話の詳細取得”

GET https://app.quickchat.ai/v1/api_core/conversations/{conversation_id}/

Terminal window
curl https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/ \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "id": "conv-uuid-1234",
  "ord": 42,
  "created_at": "2026-01-15T10:30:00Z",
  "last_message_at": "2026-01-15T10:35:00Z",
  "title": "Return policy question",
  "source": "widget",
  "terminated": false,
  "resolution_status": "open",
  "has_unread_messages": true,
  "assignee": {
    "type": "ai_assistant"
  },
  "url": null,
  "client_metadata": {"userId": 12},
  "data_gathering": null,
  "last_visitor_message_at": "2026-01-15T10:34:00Z",
  "visitor_name": "John",
  "visitor_email": "john@example.com",
  "visitor_phone_number": null,
  "visitor_label": null
}

会話メタデータ

Section titled “会話メタデータ”

会話のカスタムメタデータを保存・取得します。ダッシュボードで JSON スキーマが設定されている場合、メタデータはそのスキーマに対してバリデーションされます。

メタデータの取得

Section titled “メタデータの取得”

GET https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

Terminal window
curl https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK

{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}

メタデータの設定

Section titled “メタデータの設定”

会話のメタデータを作成または更新します。

POST https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

リクエストボディ

ParameterTypeRequiredDescription
metadataobjectYes保存するキーバリューメタデータ
Terminal window
curl -X POST https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}'

レスポンス 200 OK

{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}

AI アクション

Section titled “AI アクション”

KB AI アクションの作成

Section titled “KB AI アクションの作成”

新しいナレッジベース AI アクションを作成します。KB AI アクションにより、トリガー時にナレッジベースのタグ付きサブセットを AI が検索できるようになります。

POST https://app.quickchat.ai/v1/api/ai_actions/knowledge_base

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/knowledge_base \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{}'

レスポンス 201 Created

{
  "id": 1,
  "name": "",
  "description": "",
  "icon": null,
  "icon_color": null,
  "is_active": false,
  "is_valid": false,
  "tag": null,
  "parameter_description": "",
  "type": "knowledge_base"
}
FieldTypeDescription
idintegerAI アクション識別子
namestring表示名（最大 100 文字）
descriptionstringアクションがトリガーされるタイミングの説明（最大 1000 文字）
iconstring or nullアイコン識別子
icon_colorstring or nullアイコンの色
is_activebooleanアクションが有効かどうか
is_validbooleanアクションが正しく設定されているかどうか
tagstring or null記事をフィルタするナレッジベースタグ（最大 255 文字）
parameter_descriptionstringAI が抽出するパラメータの説明（最大 500 文字）
typestring常に "knowledge_base"

KB AI アクションの取得

Section titled “KB AI アクションの取得”

GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/knowledge_base

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions/1/knowledge_base \
  -H 'Authorization: Bearer <API_TOKEN>'

レスポンス 200 OK — AI アクションオブジェクトを返します（KB AI アクションの作成 レスポンスと同じスキーマ）。

KB AI アクションの更新

Section titled “KB AI アクションの更新”

PUT https://app.quickchat.ai/v1/api/ai_actions/{action_id}/knowledge_base

リクエストボディ

ParameterTypeRequiredDescription
namestringYes表示名（最大 100 文字）
descriptionstringYesアクションがトリガーされるタイミング（最大 1000 文字）
parameter_descriptionstringYesパラメータの説明（最大 500 文字）
tagstringYesフィルタ対象のナレッジベースタグ（最大 255 文字）
Terminal window
curl -X PUT https://app.quickchat.ai/v1/api/ai_actions/1/knowledge_base \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Search Returns",
  "description": "Search the return policy articles when customer asks about returns.",
  "parameter_description": "The return-related query from the customer",
  "tag": "returns"
}'

レスポンス 200 OK — 更新された AI アクションオブジェクトを返します。

Home Log in Blog Status Page Contact

Get started

はじめに クイックスタート

Conversations

受信トレイ インサイト

AI Agent

アイデンティティ ナレッジベース アクション

Channels

API API (Legacy) Discord Drupal Hubspot Intercom Jira MCP Shopify Slack Telegram ウェブサイト WhatsApp Zendesk