Zum Inhalt springen

Manage your AI Agent's AI Actions via the API.

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

AI Actions extend your AI Agent’s capabilities beyond answering questions from the Knowledge Base. They let you define triggered behaviors — things the AI should do when it detects specific situations in a conversation.

What AI Actions do:

  • HTTP Request Actions — Call external APIs when triggered. For example, check order status in your backend, create a support ticket, or look up account information — all during the conversation.
  • Remote MCP Actions — Connect to Model Context Protocol servers for advanced tool integrations (e.g., Shopify product lookups, custom database queries).

Typical use cases:

  • Look up real-time information (order status, account details, inventory) from your backend systems during conversations
  • Create tickets, update CRM records, or trigger workflows in external systems based on conversation context
  • Provide personalized recommendations by querying your product catalog

Each action has a name, description (which tells the AI when to trigger it), and a type-specific configuration. Actions can be enabled/disabled individually via the API. Actions are created and fully configured in the Quickchat Dashboard — the API provides list, update (enable/disable), and delete operations.

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 identifier
name
string
Display name
description
string
When the action triggers
is_active
boolean
Whether enabled
type
string
"http_request", "remote_mcp", or "shopify_remote_mcp"
icon
string or null
Icon identifier
icon_color
string or null
Icon color
is_valid
boolean
Whether properly configured
Scope: write_all

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

Request Body

ParameterDescription
is_active
boolean
Enable/disable the action
icon
string
Icon identifier (max 200 chars)
icon_color
string
Icon color (max 50 chars)
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 — Returns the updated AI Action snapshot.

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 204 No Content