Skip to main content
GET
Obtenha o saldo restante e utilizado da chave de API (token) atual. Este endpoint é usado para monitorar o uso de um único token.

Autorização

string
obrigatório
Todos os endpoints da API exigem autenticação por Bearer TokenObtenha sua chave de API:Acesse a página de gerenciamento de chaves de API para obter sua chave de APIAdicione-a ao cabeçalho da requisição:

Endpoints

Ambos os endpoints possuem a mesma funcionalidade, você pode usar qualquer um deles.

Resposta

boolean
Indica se a requisição foi bem-sucedida
string
Mensagem de erro (retornada apenas em caso de falha)
float
Saldo restante do token (retornado em caso de sucesso). Retorna -1 quando unlimited_quota é true
integer
Créditos restantes do token (retornado em caso de sucesso). Retorna -1 quando unlimited_quota é true
float
Saldo utilizado do token (retornado em caso de sucesso)
integer
Créditos utilizados do token (retornado em caso de sucesso)
boolean
Indica se o token possui cota ilimitada. true significa ilimitado, false significa limitado

Casos de uso

  • Monitorar o consumo de uma única chave de API
  • Exibir o saldo atual do token em sua aplicação
  • Configurar alertas de saldo quando o saldo cair abaixo de um limite
Informações sobre a unidade do saldoA unidade do valor do saldo depende da configuração do sistema:
  • USD - Dólares americanos
  • Credits - Créditos
Token com cota ilimitadaQuando um token está configurado com cota ilimitada:
  • o campo unlimited_quota retorna true
  • o campo remain_balance retorna -1
  • o campo remain_credits retorna -1
  • o token não possui restrições de cota e pode ser usado sem limites

Erros comuns

Observação de segurançaSua chave de API é como uma senha. Mantenha-a em local seguro e não a compartilhe com outras pessoas. Em produção, sempre use HTTPS.