跳轉到主要內容
GET
/
v1
/
balance
curl --request GET \
  --url 'https://toapis.com/v1/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "remain_credits": 2100,
  "used_credits": 460,
  "credits_per_usd": 200,
  "unlimited_quota": false
}
  • 查詢當前 API Key 的剩餘額度和已使用額度
  • 監控單個令牌的使用情況
  • 支持 CORS 跨域請求
  • 實時餘額監控
獲取當前 API Key(令牌)的剩餘餘額和已使用餘額。此接口用於監控單個令牌的使用情況,同時會返回積分字段,固定按 1 USD = 200 積分 換算。

Authorizations

Authorization
string
必填
所有接口均需要使用 Bearer Token 進行認證獲取 API Key:訪問 API Key 管理頁面 獲取您的 API Key使用時在請求頭中添加:
Authorization: Bearer YOUR_API_KEY

接口端點

GET /v1/balance
GET /balance
兩個端點功能相同,可以任選其一使用。
curl --request GET \
  --url 'https://toapis.com/v1/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "remain_credits": 2100,
  "used_credits": 460,
  "credits_per_usd": 200,
  "unlimited_quota": false
}

Response

success
boolean
請求是否成功
message
string
錯誤信息(僅失敗時返回)
remain_balance
float
令牌剩餘餘額(成功時返回)。當 unlimited_quotatrue 時,該值爲 -1
used_balance
float
令牌已使用餘額(成功時返回)
remain_credits
float
令牌剩餘積分(成功時返回),固定按 1 USD = 200 積分 換算
used_credits
float
令牌已使用積分(成功時返回)
credits_per_usd
float
積分換算比例,當前返回 200
unlimited_quota
boolean
是否爲無限額度令牌。true 表示無限額度,false 表示有限額度

使用場景

  • 監控單個 API Key 的消耗情況
  • 在應用中顯示當前令牌的餘額
  • 設置餘額告警,當餘額低於閾值時通知
餘額單位說明餘額數值的單位取決於系統配置:
  • USD - 美元
  • CNY - 人民幣
  • Tokens - Token 數量
如果需要穩定讀取積分,請優先使用 remain_creditsused_credits。這兩個字段固定按 1 USD = 200 積分 換算,不受餘額展示配置影響。
無限額度令牌當令牌被設置爲無限額度時:
  • unlimited_quota 字段返回 true
  • remain_balance 字段返回 -1
  • 該令牌不受額度限制,可無限使用

常見錯誤

錯誤信息原因解決方案
無 Authorization 頭未提供 Authorization 請求頭添加 Authorization: Bearer sk-xxxxx 請求頭
獲取令牌信息失敗令牌不存在或已刪除檢查令牌 key 是否正確
安全提示API Key 相當於密碼,請妥善保管,不要泄露給他人。生產環境請務必使用 HTTPS。