> ## 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 da chave na Platform API: API keys, billing e equipe.

<Tip>
  A chave retornada em `POST /v1/platform/verify` vem com **escopos vazios** = acesso **ADMIN** (tudo) durante o onboarding. Em produção, crie chaves restritas via `POST /v1/platform/api-keys`.
</Tip>

## Em poucas palavras

* Cada API key pertence a **um workspace**.
* Escopos vazios na criação = **acesso total** (equivalente a ADMIN).
* **API keys** usam `api_keys:read` e `api_keys:manage`
* **Billing** (plano, saldo, cartões, histórico de créditos) usa `billing:read` e `billing:manage`.
* **Equipe** (membros e convites) usa `workspace:members:read` e `workspace:members:manage` .
* Mensageria usa os escopos de canal documentados em cada API (WhatsApp, SMS, e-mail…).

Guia geral: [Chaves de API](/guides/api-key/index).

***

## Escopos por área

| Área                               | Leitura                  | Gestão                                                     |
| ---------------------------------- | ------------------------ | ---------------------------------------------------------- |
| API keys (`/v1/platform/api-keys`) | `api_keys:read`          | `api_keys:manage`                                          |
| Billing (plano, saldo, cartões)    | `billing:read`           | `billing:manage`                                           |
| Uso de créditos (`/credits/usage`) | `billing:read`           | —                                                          |
| Membros e convites                 | `workspace:members:read` | `workspace:members:manage`                                 |
| Workspaces (`/v1/workspaces`)      | `workspace:read`         | `workspace:create`, `workspace:update`, `workspace:delete` |

Com `sessionToken` de login, membros **OWNER/ADMIN** podem operar billing, chaves e equipe sem escopos na API key.

***

## Como enviar a chave

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

Alternativa: `x-api-key: sk_live_xxxxx`.

***

## Rotas de API keys (`/v1/platform/api-keys`)

| Método | Rota                               | Escopo            | Descrição                                              |
| ------ | ---------------------------------- | ----------------- | ------------------------------------------------------ |
| GET    | `/v1/platform/api-keys`            | `api_keys:read`   | Lista chaves (`?includeRevoked=true` inclui revogadas) |
| POST   | `/v1/platform/api-keys`            | `api_keys:manage` | Cria chave (`key` **uma vez**)                         |
| GET    | `/v1/platform/api-keys/:id`        | `api_keys:read`   | Detalhe (sem plaintext)                                |
| PATCH  | `/v1/platform/api-keys/:id`        | `api_keys:manage` | Nome, escopos, limites, instâncias/domínios/apps       |
| POST   | `/v1/platform/api-keys/:id/revoke` | `api_keys:manage` | Soft revoke (`revokedAt`)                              |