Pular para o conteúdo

Gerencie as AI Actions do seu Agente de IA via API.

As AI Actions estendem as capacidades do seu Agente de IA para além de responder perguntas a partir da Base de Conhecimento. Elas permitem definir comportamentos acionados — coisas que a IA deve fazer quando detecta situações específicas em uma conversa.

O que as AI Actions fazem:

  • HTTP Request Actions — Chamam APIs externas quando acionadas. Por exemplo, verificar o status de um pedido no seu backend, criar um ticket de suporte ou consultar informações de conta — tudo durante a conversa.
  • Remote MCP Actions — Conectam-se a servidores Model Context Protocol para integrações avançadas de ferramentas (ex.: consultas de produtos da Shopify, queries personalizadas a bancos de dados).

Casos de uso típicos:

  • Consultar informações em tempo real (status de pedido, detalhes de conta, estoque) nos seus sistemas de backend durante as conversas
  • Criar tickets, atualizar registros de CRM ou disparar workflows em sistemas externos com base no contexto da conversa
  • Fornecer recomendações personalizadas consultando seu catálogo de produtos

Cada action tem um name, uma description (que informa à IA quando acioná-la) e uma configuração específica do tipo. As actions podem ser ativadas/desativadas individualmente via API. As actions são criadas e totalmente configuradas no Dashboard do Quickchat — a API oferece operações de listagem, atualização (ativar/desativar) e exclusão.

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
Identificador da AI Action
name
string
Nome de exibição
description
string
Quando a action é acionada
is_active
boolean
Se está ativada
type
string
"http_request", "remote_mcp", "shopify_remote_mcp" ou "knowledge_base"
icon
string or null
Identificador do ícone
icon_color
string or null
Cor do ícone
is_valid
boolean
Se está configurada corretamente
Scope: write_all

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

Request Body

ParameterDescription
is_active
boolean
Ativar/desativar a action
icon
string
Identificador do ícone (máx. 200 caracteres)
icon_color
string
Cor do ícone (máx. 50 caracteres)
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 — Retorna o snapshot atualizado da 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 (corpo vazio)