Skip to main content
GET
Use uma API Key para consultar os gastos de um período, com filtros por modelo e agrupamento por modelo, dia civil ou ambos. O resultado agregado é retornado diretamente, sem criar tarefas nem consultar seu status repetidamente.

Autenticação

string
obrigatório
Use a mesma API Key das chamadas aos modelos com autenticação Bearer Token. Obtenha a chave na página de gerenciamento de API Keys.
A consulta funciona mesmo com saldo 0. O saldo não é verificado, mas o status e a validade da chave, a lista de IPs permitidos e o status da conta são verificados.

Endpoints

Os dois endpoints têm a mesma função e suportam CORS. Proteja sua API Key e não a exponha em código público de frontend.

Parâmetros da requisição

Todos os parâmetros são enviados na query da URL.
integer | string
Início do período, inclusive. Aceita timestamp Unix em segundos ou string RFC3339 com fuso horário, como 2026-09-01T00:00:00+08:00.Se omitido, usa 24 horas antes de end. Os timestamps são em segundos, não milissegundos.
integer | string
Fim do período, exclusivo. Mesmo formato de start; se omitido, usa o horário atual.Deve ser posterior a start, e end - start não pode exceder 31 dias.
string
Nome do modelo. Se omitido, inclui todos os modelos. Separe vários modelos por vírgulas; máximo de 50.Correspondência exata, sem diferenciar maiúsculas e minúsculas. Não aceita curingas.Exemplo: gpt-5.6-luna,sora-2
string
padrão:"none"
Agrupamento:
  • none: apenas o total; items é um array vazio
  • model: por modelo
  • date: por dia civil
  • model,date: por modelo e dia civil
string
padrão:"Asia/Shanghai"
Nome de fuso horário IANA. Padrão: Asia/Shanghai.Afeta apenas os limites dos dias quando group_by inclui date, sem alterar os instantes de início e fim. Horários RFC3339 são interpretados conforme seu próprio fuso.
string
padrão:"key"
Escopo das estatísticas:
  • key: apenas a API Key atual (padrão)
  • account: todas as API Keys da conta à qual pertence a chave atual
O intervalo é [start, end): inclui o início e exclui o fim. Use o mesmo instante para o end da consulta anterior e o start da seguinte para evitar contagem duplicada na fronteira.Ao montar a URL manualmente, codifique o + de RFC3339 como %2B. cURL --data-urlencode, Python params e JavaScript URLSearchParams nos exemplos fazem isso automaticamente.

Exemplos de requisição

Total da API Key atual nas últimas 24 horas

Sem parâmetros de query, são usados o período, escopo e agrupamento padrão.

Gastos diários da conta inteira para modelos específicos

Consultar os gastos de 11 a 18 de setembro de 2026 no horário de Pequim, excluindo 18 de setembro.

Agrupar por modelo e dia civil

Nesse agrupamento, cada elemento de items contém model e date.

Campos da resposta

boolean
Sucesso da consulta: true em caso de sucesso e false em caso de erro na consulta de uso.
object
Em caso de sucesso, retorna o escopo, o total e os detalhes agrupados.
data.total e data.items[] compartilham os campos estatísticos a seguir:
object
Em erros de consulta de uso, contém code, message e type, sendo type igual a usage_query_error. Erros de autenticação 401 / 403 são retornados pela camada de autenticação.

Limites e cache

  • Máximo de 60 consultas por minuto por API Key; limites globais da API também se aplicam
  • Resultados com os mesmos parâmetros ficam em cache por 60 segundos; o cabeçalho X-Usage-Cache é hit ou miss
  • Os gastos geralmente aparecem em até 1 segundo, mas o último minuto pode estar incompleto e há possíveis atrasos do cache
  • Recomenda-se intervalo de pelo menos 1 minuto; não use como notificação de cobrança em tempo real

Critérios de contabilização

  • Baseado em chamadas faturadas com sucesso, com os mesmos dados do painel do site
  • Chamadas com falha e tarefas reembolsadas após falha são excluídas; não é preciso compensá-las manualmente. Lotes de imagens parcialmente bem-sucedidos são cobrados pelas imagens efetivamente entregues
  • Considera o momento do lançamento da cobrança. Tarefas assíncronas de imagem e vídeo são contabilizadas na conclusão, não no envio; tarefas que passam da meia-noite pertencem ao dia da conclusão
  • Uma API Key recriada após exclusão é uma nova chave. A consulta scope=key da nova chave não inclui o histórico da anterior
  • Ajustes manuais de saldo não são gastos de chamadas e ficam fora das estatísticas
  • Dados posteriores a 27 de abril de 2026 estão disponíveis

Tratamento de erros

503 usage_unavailable não retorna valores monetários. Significa que a consulta está indisponível, não que os gastos são 0. Não converta falhas em valores zero nem sobrescreva um resultado anterior bem-sucedido.

Comparação com outros endpoints

Para o saldo restante, use Consultar saldo do token ou Consultar saldo do usuário.