> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Escopos da API Key

> Permissões para eventos, automações e execuções.

<Tip>
  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.
</Tip>

Cada **escopo** libera um tipo de operação em Automações. Use só o que sua integração precisa.

## Como enviar a chave

**Recomendado**

```http theme={null}
Authorization: Bearer sk_live_sua_chave_aqui
```

**Alternativo**

```http theme={null}
x-api-key: sk_live_sua_chave_aqui
```

<Info>
  A API Key pertence a **um** workspace. Você não acessa outro workspace com a mesma chave.
</Info>

## Combinações comuns

<CardGroup cols={2}>
  <Card title="Só disparar eventos" icon="bolt">
    `events:read`, `events:write`
  </Card>

  <Card title="Só consultar" icon="magnifying-glass">
    `events:read`, `automations:read`
  </Card>

  <Card title="Montar fluxos pela API" icon="diagram-project">
    `events:*`, `automations:*`
  </Card>

  <Card title="Integração completa" icon="gear">
    `events:read`, `events:write`, `automations:read`, `automations:write`
  </Card>
</CardGroup>

<Warning>
  Lista de escopos **vazia** na criação = acesso **ADMIN**. Em produção, restrinja sempre.
</Warning>

## Eventos (`events:*`)

<AccordionGroup>
  <Accordion title="events:read">
    Listar e buscar definições de evento.
  </Accordion>

  <Accordion title="events:write">
    Criar, atualizar e excluir eventos. **Disparar evento** (Enviar evento) que inicia execuções.
  </Accordion>
</AccordionGroup>

## Automações (`automations:*`)

<AccordionGroup>
  <Accordion title="automations:read">
    Listar automações, buscar detalhe e **listar execuções (runs)**.
  </Accordion>

  <Accordion title="automations:write">
    Criar, atualizar, excluir automações e **parar** automação em execução.
  </Accordion>
</AccordionGroup>

## 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

| Código HTTP | Situação                                                                        |
| ----------- | ------------------------------------------------------------------------------- |
| **403**     | Escopo ausente ou onboarding incompleto (`ONBOARDING_REQUIRED`)                 |
| **402**     | Workspace bloqueado ou limite de automações do plano (`PLAN_LIMIT_AUTOMATIONS`) |
| **400**     | Grafo inválido (`INVALID_GRAPH`, `GRAPH_CYCLE`, etc.)                           |

Detalhe em [Respostas de erro](/guides/conceitos/resposta-de-erros) e na spec **Automações e eventos** no menu.

## Próximos passos

* [Quick Start](/automations-api/como-funciona/quick-start)
* [Introdução](/automations-api/como-funciona/introducao)
* [Chaves de API (guia)](/guides/api-key/index)