88API88API
使用指南AI 應用API 文件幫助支援

令牌用量查詢(Token Usage)

功能說明

透過認證查詢當前 Bearer Token 的額度使用情況:授予總量、已用、剩餘、是否無限、模型限額及到期時間。

📮 端點

GET /api/usage/token
  • 需要在請求頭中攜帶鑑權資訊
  • 僅返回當前請求所使用的 Token 的用量資訊

🔐 鑑權

在請求頭中包含以下內容進行 API 金鑰認證:

Authorization: Bearer $API_KEY
  • 支援攜帶或不攜帶 sk- 字首,服務端會自動相容
  • 缺少或無效的 Authorization 頭將返回 401

💡 請求示例

curl -X GET https://88api.ai/api/usage/token \
  -H "Authorization: Bearer $API_KEY"

✅ 成功響應示例

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "Default Token",
    "total_granted": 1000000,
    "total_used": 12345,
    "total_available": 987655,
    "unlimited_quota": false,
    "model_limits": {
      "gpt-4o-mini": true
    },
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

❗ 錯誤響應示例

  • 缺少鑑權頭:
{
  "success": false,
  "message": "No Authorization header"
}
  • 非 Bearer 方案:
{
  "success": false,
  "message": "Invalid Bearer token"
}
  • Token 查詢失敗(例如無效或已刪除):
{
  "success": false,
  "message": "token not found"
}

🧾 欄位說明(data)

  • object: 固定為 token_usage
  • name: 令牌名稱
  • total_granted: 授予總量(= 已用 + 剩餘)
  • total_used: 已使用額度
  • total_available: 可用剩餘額度
  • unlimited_quota: 是否為無限額度
  • model_limits: 允許使用的模型列表
  • model_limits_enabled: 是否啟用模型限額
  • expires_at: 到期時間的 Unix 時間戳(秒)。若永不過期返回 0(由後端將 -1 歸一化為 0

參考實現:GET /api/usage/token 新增於 PR #1161