Saltar para o conteúdo principal
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Obtenha o saldo restante e utilizado da chave de API (token) atual. Este endpoint é usado para monitorar o uso de um único token. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
Autorização

​
Authorization
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:
Authorization: Bearer YOUR_API_KEY

​
Endpoints

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

​
Resposta

​
success
boolean
Indica se a requisição foi bem-sucedida
​
message
string
Mensagem de erro (retornada apenas em caso de falha)
​
remain_balance
float
Saldo restante do token (retornado em caso de sucesso). Retorna -1 quando unlimited_quota é true
​
used_balance
float
Saldo utilizado do token (retornado em caso de sucesso)
​
unlimited_quota
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
  • CNY - Yuan chinês
  • Tokens - Quantidade de tokens
Token com cota ilimitadaQuando um token está configurado com cota ilimitada:
  • o campo unlimited_quota retorna true
  • o campo remain_balance retorna -1
  • o token não possui restrições de cota e pode ser usado sem limites

​
Erros comuns

Mensagem de erroCausaSolução
No Authorization headerCabeçalho Authorization não fornecidoAdicione o cabeçalho Authorization: Bearer sk-xxxxx
Failed to get token infoO token não existe ou foi removidoVerifique se a chave do token está correta
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.