Pular para o conteúdo
GET/relatorios/creditos

Créditos de IA usados

relatorios:lerexporta CSV

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.

GET /relatorios/creditos

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"
Resposta 200 · JSON (com formato=csv, CSV)
{
  "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
      }
    ]
  }
}

Parâmetros de consulta#

  • dedata AAAA-MM-DDopcional

    Primeiro dia (AAAA-MM-DD, no fuso da organização). Padrão: 29 dias antes de ate.

  • atedata AAAA-MM-DDopcional

    Último dia, inclusive. Padrão: hoje. O período vai até 366 dias.

  • granularidade"dia" | "semana" | "mes"opcional

    Tamanho de cada linha da série: dia (padrão), semana (começa na segunda) ou mes.

  • formato"json" | "csv"opcional

    json (padrão) ou csv (UTF-8 com BOM, separado por vírgula, pronto para planilha).

Resposta#

200 com {"dados": ...}: RelatorioCreditos. Com formato=csv, um arquivo CSV.

  • periodoobjectopcional

    O período que valeu na consulta (com os padrões aplicados).

  • periodo.dedata AAAA-MM-DDopcional
    —
  • periodo.atedata AAAA-MM-DDopcional
    —
  • periodo.diasintegeropcional
    —
  • periodo.fusostringopcional
    • ex.: America/Sao_Paulo
  • periodo.granularidade"dia" | "semana" | "mes"opcional

    Só nos relatórios em série.

  • periodo.caixa_iduuidopcional
    —
  • resumoobjectopcional
    —
  • resumo.creditos_usadosintegeropcional

    Créditos gastos no período.

  • resumo.creditos_disponiveisintegeropcional
    —
  • resumo.creditos_do_planointegeropcional
    —
  • resumo.creditos_extrasintegeropcional
    —
  • resumo.renovam_emdata e hora ISO 8601 ou nullopcional
    —
  • por_motivolista de objectopcional
    —
  • por_motivo[].motivostringopcional
    • ex.: resposta do agente
  • por_motivo[].creditos_usadosintegeropcional
    —
  • por_motivo[].vezesintegeropcional
    —
  • linhaslista de objectopcional

    Uma linha por dia, semana ou mês.

  • linhas[].iniciodata AAAA-MM-DDopcional
    —
  • linhas[].fimdata AAAA-MM-DDopcional

    Último dia da linha (nas pontas do período, a linha é cortada).

  • linhas[].creditos_usadosintegeropcional
    —

Erros#

Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.

Status de erro desta operação
StatusQuando
401Chave ausente ou inválida (resposta igual para qualquer motivo).
403Plano sem API, escopo insuficiente ou https/origem recusados.
422Dados 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).
429Limite de requisições. Veja Retry-After.
Códigos de erro que esta área pode devolver6
  • periodo_longoEscolha um período de até 366 dias.
  • periodo_invalidoPeríodo inválido: `de` precisa ser antes de `ate` (AAAA-MM-DD).
  • granularidade_invalidagranularidade deve ser dia, semana ou mes.
  • caixa_invalidaCaixa não encontrada nesta organização (veja GET /me).
  • limite_relatoriosRelatórios têm limite próprio, mais baixo. Espere o tempo de Retry-After.
  • relatorio_demorouO relatório demorou demais. Escolha um período menor ou uma granularidade maior (semana ou mes).

Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.