Skip to main content
Escopos da API v1 (API Key). Bases de conhecimento, assistentes e MCP são configurados no painel, não fazem parte da referência v1.
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
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.

​
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