Referência da API

Saldo

GET/v1/balance

Retorna o saldo da conta e quanto a chave de API que faz a chamada ainda pode gastar, em USD. Gratuito e somente leitura: sem chamada de modelo, nada é cobrado. Chaves esgotadas ou expiradas ainda podem chamá-lo; só chaves desativadas são recusadas.

#Parâmetros da requisição

  • Authorizationheaderobrigatório

    Bearer sk-YOUR_KEY. Não há corpo nem parâmetro de query.

balance é a carteira inteira da conta e pode ficar negativo depois que um trabalho grande é liquidado. available é o que esta chave pode gastar agora: o menor valor entre balance e o limite restante da própria chave, nunca abaixo de zero. key.remaining é null quando a chave não tem limite próprio; expires_at 0 significa que ela nunca expira.

Integrações B2B podem consultá-lo antes de enviar trabalho e avisar a equipe quando available estiver baixo. Com a assinatura de requisições ativada, assine-o como qualquer outra chamada com essa chave, usando o caminho /v1/balance.

#Erros relacionados

  • 401Chave ausente, inválida ou desativada — ou, com a assinatura de requisições ativada, uma assinatura ausente ou incorreta.
  • 403A conta está desativada.
  • 500Não foi possível ler o saldo. Tente novamente em alguns segundos.

Tabela completa de códigos de erro →

#Exemplo de requisição

curl https://www.aisplice.store/v1/balance \
  -H "Authorization: Bearer sk-YOUR_KEY"

#Resposta

response.json
{
  "object": "balance",
  "currency": "USD",
  "balance": 12.5,
  "available": 2,
  "key": {
    "name": "app",
    "unlimited": false,
    "remaining": 2,
    "used": 1,
    "expires_at": 0
  }
}

Ainda com problemas?

Envie para nós o ID da requisição ou a mensagem de erro e vamos investigar.