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

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "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 conta de usuário atual. Este endpoint retorna informações de saldo a nível de usuário, independente de tokens específicos, para visualização do saldo geral da conta. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "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/user/balance
GET /user/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 usuário (retornado em caso de sucesso). Retorna -1 quando unlimited_quota é true
​
used_balance
float
Saldo utilizado do usuário (retornado em caso de sucesso)
​
unlimited_quota
boolean
Indica se o usuário possui cota ilimitada. true significa ilimitado, false significa limitado

​
Saldo do token vs. saldo do usuário

ComparaçãoSaldo do token (/v1/balance)Saldo do usuário (/v1/user/balance)
EscopoToken individualConta de usuário inteira
Fonte de dadosRemainQuota e UsedQuota do tokenquota e used_quota do usuário
Caso de usoMonitorar o uso de uma única chave de APIVisualizar o saldo geral da conta
Limitado porLimites de cota a nível de tokenLimites de cota a nível de usuário

​
Casos de uso

  • Visualizar o saldo geral da conta de usuário
  • Configurar lembretes de recarga e alertas de saldo
  • Exibir o saldo da conta no painel do usuário
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
Usuário com cota ilimitadaQuando um usuário está configurado com cota ilimitada:
  • o campo unlimited_quota retorna true
  • o campo remain_balance retorna -1
  • o usuário não possui restrições de cota e pode usar a API 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 user quotaO usuário não existeVerifique se o usuário associado ao token existe
Failed to get used quotaErro de consulta ao banco de dadosEntre em contato com o administrador para verificar o status do sistema
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.