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

# API key scopes

> Permissions for events, automations, and runs.

<Tip>
  Scopes for the **v1 API** (API Key). Knowledge bases, assistants, and MCP are configured **in the dashboard**, not part of the v1 reference.
</Tip>

Each **scope** unlocks a type of operation in Automations. Use only what your integration needs.

## How to send the key

**Recommended**

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

**Alternative**

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

<Info>
  The API key belongs to **one** workspace. You cannot access another workspace with the same key.
</Info>

## Common combinations

<CardGroup cols={2}>
  <Card title="Only send events" icon="bolt">
    `events:read`, `events:write`
  </Card>

  <Card title="Read only" icon="magnifying-glass">
    `events:read`, `automations:read`
  </Card>

  <Card title="Build flows via API" icon="diagram-project">
    `events:*`, `automations:*`
  </Card>

  <Card title="Full integration" icon="gear">
    `events:read`, `events:write`, `automations:read`, `automations:write`
  </Card>
</CardGroup>

<Warning>
  **Empty** scope list on creation = **ADMIN** access. Always restrict in production.
</Warning>

## Events (`events:*`)

<AccordionGroup>
  <Accordion title="events:read">
    List and fetch event definitions.
  </Accordion>

  <Accordion title="events:write">
    Create, update, and delete events. **Send event** to start runs.
  </Accordion>
</AccordionGroup>

## Automations (`automations:*`)

<AccordionGroup>
  <Accordion title="automations:read">
    List automations, fetch detail, and **list runs**.
  </Accordion>

  <Accordion title="automations:write">
    Create, update, delete automations, and **stop** a running automation.
  </Accordion>
</AccordionGroup>

## Sends inside the flow

Steps that send WhatsApp, email, SMS, etc. use the **same send engine** as channels. The key needs the matching send scopes (`whatsapp:send`, `email:send`, `sms:send`, `telegram:send`, etc.).

## Common errors

| HTTP code | Situation                                                             |
| --------- | --------------------------------------------------------------------- |
| **403**   | Missing scope or incomplete onboarding (`ONBOARDING_REQUIRED`)        |
| **402**   | Blocked workspace or plan automation limit (`PLAN_LIMIT_AUTOMATIONS`) |
| **400**   | Invalid graph (`INVALID_GRAPH`, `GRAPH_CYCLE`, etc.)                  |

Details in [Error responses](/en/guides/conceitos/resposta-de-erros) and the **Automations and events** spec in the menu.

## Next steps

* [Quick Start](/en/automations-api/como-funciona/quick-start)
* [Introduction](/en/automations-api/como-funciona/introducao)
* [API keys (guide)](/guides/api-key/index)