# GET /modelos — Listar modelos do WhatsApp

- URL: `GET https://chat.forsi.com.br/api/v1/modelos`
- Acesso: escopo `modelos:ler` · módulo do plano: API
- Sucesso: `200`, `{"dados": ...}` com lista de `Modelo`
- Página: https://docs.forsi.com.br/api/modelos/listar-modelos (Markdown: https://docs.forsi.com.br/api/modelos/listar-modelos.md)

Modelos da API oficial sincronizados com a Meta, com as variáveis de cada um.

**Parâmetros de consulta (query string)**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `estado` | string | não | APPROVED, PENDING, REJECTED... até 30 caracteres |
| `caixa_id` | uuid | não |  |

**Exemplo (curl)**

```bash
curl "https://chat.forsi.com.br/api/v1/modelos?estado=APPROVED" \
  -H "Authorization: Bearer $FORSI_CHAVE"
```

**JavaScript (fetch)**

```js
const resposta = await fetch('https://chat.forsi.com.br/api/v1/modelos?estado=APPROVED', {
  headers: {
    Authorization: `Bearer ${process.env.FORSI_CHAVE}`,
  },
});
const json = await resposta.json();
if (!resposta.ok) throw new Error(`${resposta.status} ${json.erro.codigo}: ${json.erro.mensagem}`);
console.log(json.dados);
```

**Python (requests)**

```python
import os
import requests

resposta = requests.get(
    "https://chat.forsi.com.br/api/v1/modelos",
    headers={
        "Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
    },
    params={
        "estado": "APPROVED",
    },
    timeout=30,
)
corpo = resposta.json()
if not resposta.ok:
    raise RuntimeError(f"{resposta.status_code} {corpo['erro']['codigo']}: {corpo['erro']['mensagem']}")
print(corpo["dados"])
```

**Resposta `200` (exemplo)**

```json
{
  "dados": [
    {
      "id": "2eabdd6d-7cb0-4c12-9da3-8f9441056099",
      "nome": "lembrete_consulta",
      "idioma": "pt_BR",
      "categoria": "UTILITY",
      "estado": "APPROVED",
      "caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445",
      "formato_parametros": "positional",
      "variaveis": ["texto"],
      "texto": "Olá {{1}}, sua consulta é amanhã às {{2}}.",
      "componentes": [],
      "atualizado_em": "2026-10-04T13:05:12.481Z"
    }
  ]
}
```

**Campos de `Modelo`**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | não |  |
| `nome` | string | não |  |
| `idioma` | string | não |  |
| `categoria` | string | não |  |
| `estado` | string | não | ex.: APPROVED |
| `caixa_id` | uuid | não |  |
| `formato_parametros` | string | não |  |
| `variaveis` | lista de string | não |  |
| `texto` | string | não |  |
| `componentes` | array | não |  |
| `atualizado_em` | data e hora ISO 8601 | não |  |

**Erros**

- `401`: Chave ausente ou inválida (resposta igual para qualquer motivo).
- `403`: Plano sem API, escopo insuficiente ou https/origem recusados.
- `422`: Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
- `429`: Limite de requisições. Veja Retry-After.
- Códigos comuns aqui: `caixa_inexistente`.

---

Página: https://docs.forsi.com.br/api/modelos/listar-modelos · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt