- Query the remaining and used quota of the current API Key
- Monitor single token usage
- CORS cross-origin support
- Real-time balance monitoring
Get the remaining and used balance of the current API Key (token). This endpoint is used to monitor the usage of a single token.
Authorizations
All endpoints require Bearer Token authenticationGet your API Key:Visit the API Key Management Page to get your API KeyAdd it to the request header:Authorization: Bearer YOUR_API_KEY
Endpoints
GET /v1/balance
GET /balance
Both endpoints have the same functionality, you can use either one.
curl --request GET \
--url 'https://dashlyai.cc/v1/balance' \
--header 'Authorization: Bearer <token>'
{
"success": true,
"remain_balance": 10.5,
"used_balance": 2.3,
"unlimited_quota": false
}
Response
Whether the request was successful
Error message (only returned on failure)
Token remaining balance (returned on success). Returns -1 when unlimited_quota is true
Token used balance (returned on success)
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
- CNY - Chinese Yuan
- Tokens - Token count
Unlimited Quota TokenWhen a token is set to unlimited quota:
unlimited_quota field returns true
remain_balance field returns -1
- The token has no quota restrictions and can be used without limits
Common Errors
| Error Message | Cause | Solution |
|---|
| No Authorization header | Authorization header not provided | Add Authorization: Bearer sk-xxxxx header |
| Failed to get token info | Token doesn’t exist or has been deleted | Check if the token key is correct |
Security NoteYour API Key is like a password. Keep it secure and don’t share it with others. Always use HTTPS in production.