Skip to main content
Escopos da API v1 (API Key) para automações, assistentes, bases de conhecimento, MCP, HTTP tools, pipelines, sending pools e AI Web Widget admin.
Cada escopo libera um tipo de operação em Automações. Use só o que sua integração precisa.

​
Como enviar a chave

Recomendado
Alternativo
A API Key pertence a um workspace. Você não acessa outro workspace com a mesma chave.

​
Combinações comuns

Só disparar eventos

events:read, events:write

Só consultar

events:read, automations:read

Montar fluxos pela API

events:*, automations:*

Integração completa

events:read, events:write, automations:read, automations:write, assistants:read, assistants:write, assistants:invoke, knowledge_bases:read, knowledge_bases:write, mcp_connections:read, mcp_connections:write, http_tools:read, http_tools:write
Lista de escopos vazia na criação = acesso ADMIN. Em produção, restrinja sempre.

​
Eventos (events:*)

Listar e buscar definições de evento.
Criar, atualizar e excluir eventos. Disparar evento (Enviar evento) que inicia execuções.

​
Automações (automations:*)

Listar automações, buscar detalhe e listar execuções (runs).
Criar, atualizar, excluir automações e parar automação em execução.

​
Assistentes (assistants:*)

Listar e buscar assistentes; listar bindings MCP e HTTP tool.
Criar, atualizar e excluir assistentes; vincular/desvincular MCP e HTTP tools.
Invocar assistente em modo teste (POST /v1/assistants/{id}/invoke) e ler histórico do thread.

​
Bases de conhecimento (knowledge_bases:*)

Listar bases e documentos; obter detalhe com sourceText.
CRUD de bases e documentos (reindexação automática após alterar texto).

​
MCP (mcp_connections:*)

Listar e obter conexões MCP do workspace.
Criar, atualizar e excluir conexões; POST /v1/mcp-connections/{id}/refresh-manifest para CUSTOM_URL.OAuth Google/Microsoft para conectores curados continua no painel; via API use CUSTOM_URL + bearerToken.

​
HTTP tools (http_tools:*)

Listar e obter ferramentas REST allowlist.
Criar, atualizar e excluir HTTP tools.

​
Pipelines (pipelines:*)

Boards, overview, cards por contato.
CRUD de boards, colunas, cards e movimentação.

​
Sending pools (sending_pools:*)

Listar pools, detalhe e stats.
CRUD de pools e membros (instâncias WhatsApp).

​
AI Web Widget admin (ai_widgets:*)

Listar widgets e mensagens do add-on.
CRUD de widgets, rotate key/HMAC, duplicar.

​
Envios dentro do fluxo

Passos que mandam WhatsApp, e-mail, SMS, etc. usam o mesmo motor de envio dos canais. A chave precisa dos escopos de envio correspondentes (whatsapp:send, email:send, sms:send, telegram:send, etc.).

​
Erros comuns

Detalhe em Respostas de erro e na spec Automações e eventos no menu.

​
Próximos passos