# GET /relatorios/creditos — Créditos de IA usados

- URL: `GET https://chat.forsi.com.br/api/v1/relatorios/creditos`
- Acesso: escopo `relatorios:ler` · módulo do plano: API
- Sucesso: `200`, `{"dados": ...}` com `RelatorioCreditos`; ou CSV com `formato=csv`
- Página: https://docs.forsi.com.br/api/relatorios/relatorio-creditos (Markdown: https://docs.forsi.com.br/api/relatorios/relatorio-creditos.md)

Créditos gastos no período (por dia, semana ou mês e por tipo de uso) e o saldo atual. Só créditos: nada em dinheiro.

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

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `de` | data AAAA-MM-DD | não | Primeiro dia (AAAA-MM-DD, no fuso da organização). Padrão: 29 dias antes de `ate`. |
| `ate` | data AAAA-MM-DD | não | Último dia, inclusive. Padrão: hoje. O período vai até 366 dias. |
| `granularidade` | "dia" \| "semana" \| "mes" | não | Tamanho de cada linha da série: `dia` (padrão), `semana` (começa na segunda) ou `mes`. |
| `formato` | "json" \| "csv" | não | `json` (padrão) ou `csv` (UTF-8 com BOM, separado por vírgula, pronto para planilha). |

**Exemplo (curl)**

```bash
curl "https://chat.forsi.com.br/api/v1/relatorios/creditos?granularidade=mes&de=2026-01-01&ate=2026-09-30" \
  -H "Authorization: Bearer $FORSI_CHAVE"
```

**JavaScript (fetch)**

```js
const resposta = await fetch('https://chat.forsi.com.br/api/v1/relatorios/creditos?granularidade=mes&de=2026-01-01&ate=2026-09-30', {
  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/relatorios/creditos",
    headers={
        "Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
    },
    params={
        "granularidade": "mes",
        "de": "2026-01-01",
        "ate": "2026-09-30",
    },
    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": {
    "periodo": {
      "de": "2026-10-12",
      "ate": "2026-10-12",
      "dias": 30,
      "fuso": "America/Sao_Paulo",
      "granularidade": "dia",
      "caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445"
    },
    "resumo": {
      "creditos_usados": 12,
      "creditos_disponiveis": 12,
      "creditos_do_plano": 12,
      "creditos_extras": 12,
      "renovam_em": "2026-10-04T13:05:12.481Z"
    },
    "por_motivo": [{"motivo":"resposta do agente","creditos_usados":12,"vezes":12}],
    "linhas": [
      {
        "inicio": "2026-10-12T17:00:00.000Z",
        "fim": "2026-10-12T17:30:00.000Z",
        "creditos_usados": 12
      }
    ]
  }
}
```

**Campos de `RelatorioCreditos`**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `periodo` | object | não | O período que valeu na consulta (com os padrões aplicados). |
| `periodo.de` | data AAAA-MM-DD | não |  |
| `periodo.ate` | data AAAA-MM-DD | não |  |
| `periodo.dias` | integer | não |  |
| `periodo.fuso` | string | não | ex.: America/Sao_Paulo |
| `periodo.granularidade` | "dia" \| "semana" \| "mes" | não | Só nos relatórios em série. |
| `periodo.caixa_id` | uuid | não |  |
| `resumo` | object | não |  |
| `resumo.creditos_usados` | integer | não | Créditos gastos no período. |
| `resumo.creditos_disponiveis` | integer | não |  |
| `resumo.creditos_do_plano` | integer | não |  |
| `resumo.creditos_extras` | integer | não |  |
| `resumo.renovam_em` | data e hora ISO 8601 ou null | não |  |
| `por_motivo` | lista de object | não |  |
| `por_motivo[].motivo` | string | não | ex.: resposta do agente |
| `por_motivo[].creditos_usados` | integer | não |  |
| `por_motivo[].vezes` | integer | não |  |
| `linhas` | lista de object | não | Uma linha por dia, semana ou mês. |
| `linhas[].inicio` | data AAAA-MM-DD | não |  |
| `linhas[].fim` | data AAAA-MM-DD | não | Último dia da linha (nas pontas do período, a linha é cortada). |
| `linhas[].creditos_usados` | integer | 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: `periodo_longo`, `periodo_invalido`, `granularidade_invalida`, `caixa_invalida`, `limite_relatorios`, `relatorio_demorou`.

---

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