Skip to main content
GET
Get the remaining and used balance of the current API Key (token). This endpoint is used to monitor the usage of a single token.

Authorization

string
required
All API endpoints require Bearer Token authenticationGet your API Key:Visit the API Key Management Page to get your API KeyAdd it to the request header:

Endpoints

Both endpoints have the same functionality, you can use either one.

Response

boolean
Whether the request was successful
string
Error message (only returned on failure)
float
Token remaining balance (returned on success). Returns -1 when unlimited_quota is true
integer
Token remaining credits (returned on success). Returns -1 when unlimited_quota is true
float
Token used balance (returned on success)
integer
Token used credits (returned on success)
boolean
Whether the token has unlimited quota. true means unlimited, false means limited

Use Cases

  • Monitor consumption of a single API Key
  • Display current token balance in your application
  • Set up balance alerts when balance falls below threshold
Balance Unit InformationThe unit of the balance value depends on system configuration:
  • USD - US Dollars
  • Credits - Credits
Unlimited Quota TokenWhen a token is set to unlimited quota:
  • unlimited_quota field returns true
  • remain_balance field returns -1
  • remain_credits field returns -1
  • The token has no quota restrictions and can be used without limits

Common Errors

Security NoteYour API Key is like a password. Keep it secure and don’t share it with others. Always use HTTPS in production.