コンテンツにスキップ

API を使って AI Agent の AI Actions を管理します。

AI Actions は、Knowledge Base からの質問への回答を超えて、AI Agent の機能を拡張します。会話中に特定の状況を検出したときに AI が実行すべき トリガーされる動作 を定義できます。

AI Actions でできること:

  • HTTP Request Actions — トリガーされたときに外部 API を呼び出します。たとえば、バックエンドで注文ステータスを確認したり、サポートチケットを作成したり、アカウント情報を検索したりできます。すべて会話中に実行されます。
  • Remote MCP Actions — Model Context Protocol サーバーに接続し、高度なツール連携を実現します(例:Shopify の商品検索、カスタムデータベースクエリ)。

典型的なユースケース:

  • 会話中に、バックエンドシステムからリアルタイムの情報(注文ステータス、アカウント詳細、在庫)を検索する
  • 会話のコンテキストに基づいて、外部システムでチケットを作成したり、CRM レコードを更新したり、ワークフローをトリガーしたりする
  • 商品カタログを照会して、パーソナライズされたレコメンドを提供する

各アクションには namedescription(AI にいつトリガーするかを伝える)、およびタイプ固有の設定があります。アクションは API 経由で個別に有効化・無効化できます。アクションは Quickchat Dashboard で作成され、完全に設定されます。API は list、update(有効化・無効化)、delete の操作を提供します。

Scope: read_all

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

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

Response 200 OK

[
{
"id": 1,
"name": "Check Order Status",
"description": "Look up order status when customer asks about their order.",
"is_active": true,
"type": "http_request",
"icon": null,
"icon_color": null,
"is_valid": true
}
]
FieldDescription
id
integer
AI Action の識別子
name
string
表示名
description
string
アクションがトリガーされるタイミング
is_active
boolean
有効かどうか
type
string
"http_request""remote_mcp""shopify_remote_mcp"、または "knowledge_base"
icon
string or null
アイコン識別子
icon_color
string or null
アイコンの色
is_valid
boolean
正しく設定されているかどうか
Scope: write_all

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

Request Body

ParameterDescription
is_active
boolean
アクションの有効化 / 無効化
icon
string
アイコン識別子(最大 200 文字)
icon_color
string
アイコンの色(最大 50 文字)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"is_active": false}'

Response 200 OK — 更新された AI Action のスナップショットを返します。

Scope: write_all

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

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

Response 200 OK(空のボディ)