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

# Permissões da API key

> Escopos por rota e presets para integrações Shappire

Cada chave carrega uma lista de **escopos**. Rotas que exigem escopo retornam `403` com `error.code: "forbidden"` se a chave não tiver permissão.

## Escopos disponíveis

| Escopo           | Rotas                  |
| ---------------- | ---------------------- |
| `media:resolve`  | `POST /media/resolve`  |
| `media:download` | `POST /media/download` |

Rotas sem escopo explícito exigem apenas chave válida:

| Rota                | Auth                         |
| ------------------- | ---------------------------- |
| `GET /health`       | Pública                      |
| `GET /platforms`    | Chave válida                 |
| `GET /jobs/{jobId}` | Chave válida (mesmo projeto) |

## Presets recomendados

| Preset   | Escopos                            | Uso                                                                  |
| -------- | ---------------------------------- | -------------------------------------------------------------------- |
| Leitura  | —                                  | Apenas `GET /platforms` e `GET /jobs` (chave sem escopos de escrita) |
| Resolve  | `media:resolve`                    | Metadados e UI de preview                                            |
| Download | `media:download`                   | Worker que só enfileira jobs                                         |
| Completo | `media:resolve` + `media:download` | Integração end-to-end                                                |

<Info>
  Para fluxo completo, marque ambos os escopos na criação da chave ou crie duas chaves especializadas se seus serviços são separados.
</Info>

## Verificação no dashboard

Em [Developer → Projetos → API Keys](https://shappire.tools/developer/projects), cada chave lista os escopos ativos e data do último uso.