Query Balance

1. Endpoint Description

Endpoint standard API key query:

• API Key user ID
• user account balance
• display balance converted by site configuration
• quota information for the current API key

Endpointuse sk-... API Key call, requires usingr.

---

2. Details

Method	GET
Path	/api/usage/balance
Authentication	Authorization: Bearer sk-xxx
Content-Type	, pass

---

3. Request Examples

curl -X GET "https://api.aijisu.cn/api/usage/balance" \
 -H "Authorization: Bearer sk-your-api-key"

---

4. SuccessResponse Examples

{
  "success": true,
  "message": "",
  "data": {
    "object": "api_key_balance",
    "user_id": 1,
    "balance": {
      "quota": 1000000,
      "amount": 14.6,
      "display_amount": "¥14.60",
      "quota_per_unit": 500000,
      "quota_display_type": "CNY",
      "currency_symbol": "¥",
      "exchange_rate": 7.3
    },
    "token": {
      "id": 12,
      "name": "my-key",
      "remain_quota": 100000,
      "used_quota": 5000,
      "total_quota": 105000,
      "unlimited_quota": false,
      "expired_time": -1,
      "status": 1,
      "model_limits_enabled": false,
      "model_limits": {}
    }
  }
}

---

5. responsesParameter Reference

5.1 Parameters

Parameters	Type	Note
success	boolean	WhetherSuccess
message	string	responses, Success string
data	object	responses

5.2 data Parameters

Parameters	Type	Note
data.object	string	object type,api_key_balance
data.user_id	number	API Key user ID
data.balance	object	user account balance
data.token	object	API Key quota

5.3 data.balance Parameters

Parameters	Type	Note
data.balance.quota	number	useraccount quota, quota
data.balance.amount	number	balance
data.balance.display_amount	string	format,
data.balance.quota_per_unit	number	quota,500000 500000 quota = 1 USD
data.balance.quota_display_type	string	balance Type, value:USD, CNY, CUSTOM, TOKENS
data.balance.currency_symbol	string	,$, ¥; Type TOKENS string
data.balance.exchange_rate	number	use;USD 1, CNY, CUSTOM

5.4 data.token Parameters

Parameters	Type	Note
data.token.id	number	API Key ID
data.token.name	string	API Key name
data.token.remain_quota	number	API Key balance
data.token.used_quota	number	API Key usequota
data.token.total_quota	number	API Key quota,remain_quota + used_quota
data.token.unlimited_quota	boolean	API Key Whether quota
data.token.expired_time	number	API Key;-1
data.token.status	number	API Key Status;1
data.token.model_limits_enabled	boolean	API Key Whether Modelconstraints
data.token.model_limits	object	API Key Modelconstraints; constraints object {}

---

---

6. Errorresponses

6.1 pass API Key

HTTP Status code: 401

{
  "success": false,
  "message": "Token not provided"
}

6.2 API Key or

HTTP Status code: 401

{
  "success": false,
  "message": "Invalid token"
}

6.3 API Key

HTTP Status code: 403

{
  "success": false,
  "message": "Token invalid"
}

---

7. callNote

• use Authorization: Bearer sk-xxx pass in API Key.
• return Yes API Key user accountbalance, Yesupstream balance.
• Endpoint return API Key string.
• API Key querybalance.
• API Key orquota, querybalance, Key user.
• amount and display_amount balance.