Pular para o conteúdo
Cadastre-se grátis
Referência da API

Consultar a cota de uma API Key

Consulte a cota usada e restante de uma BetterToken API Key com autenticação Bearer. Converta as unidades em dinheiro usando a moeda e o fator de conversão retornados.

Use GET https://bettertoken.ai/api/usage/token/ para consultar a cota usada e restante de uma BetterToken API Key.

Enviar uma solicitação

Use a mesma BetterToken API Key com prefixo sk-... que você usa para chamar os modelos. Defina-a na variável de ambiente local BETTERTOKEN_API_KEY antes de executar este comando.

Autentique-se com Authorization: Bearer <API_KEY>. A solicitação não tem parâmetros nem corpo. Mantenha a barra final; a URL completa não inclui /v1.

Janela do terminal
curl -sS 'https://bettertoken.ai/api/usage/token/' \
-H "Authorization: Bearer ${BETTERTOKEN_API_KEY}"

Resposta de sucesso

code: true indica que a consulta foi concluída com sucesso. Este trecho da resposta usa valores ilustrativos.

{
"code": true,
"message": "ok",
"data": {
"object": "token_usage",
"name": "example-key",
"total_granted": 1000000,
"total_used": 250000,
"total_available": 750000,
"unlimited_quota": false,
"quota_currency": "USD"
}
}

Interpretar a cota

CampoSignificado
data.total_availableCota restante desta Key, em unidades internas de cota.
data.total_usedCota usada acumulada desta Key, nas mesmas unidades.
data.total_grantedSoma da cota usada e restante, nas mesmas unidades.
data.quota_currencyMoeda da cota, como USD.
data.unlimited_quotaQuando é true, esta Key não tem um limite de cota separado. O saldo da carteira ainda limita os gastos.

Converter em dinheiro

Leia data.quota_per_unit na resposta de GET https://bettertoken.ai/api/status. Divida a cota por esse fator para obter um valor na moeda data.quota_currency.

Valor restante = data.total_available / data.quota_per_unit

Por exemplo, com um fator de 500000, os valores do exemplo resultam em 750000 / 500000 = 1.50 USD. Converta a cota usada da mesma forma.

Para ver o saldo da carteira da sua conta, abra o BetterToken Workspace. Este endpoint retorna apenas a cota da API Key usada para autenticar a solicitação.

Para consultar as solicitações recentes desta Key, veja Logs de uma API Key.