YeeHooDevelopers
开发者文档

获取余额

查询当前 API 账户可用余额或额度状态,适合调用前做额度检测。

这个接口用于查询当前 API Key 所属团队工作空间的余额或额度状态。

GET /v1/user/balance

接口概览

说明
路由GET /v1/user/balance
鉴权Authorization: Bearer sk_yeehoo_xxx
请求体
返回200 OK + 余额对象

适用场景

  • 控制台额度页
  • 调用前额度检查
  • 运营监控或预警

Authorizations

Authorization: Bearer sk_yeehoo_your_api_key

Response

成功时通常返回余额或额度信息。

{
  "quota_amount": 1000,
  "authorized_amount": 120,
  "currency": "credits",
  "wallet_account_id": "wallet_01jxyz..."
}

响应字段说明

字段类型说明
quota_amountnumber当前可用积分,可用于新任务授权
authorized_amountnumber已被运行中任务授权或冻结的积分,不代表累计充值总额
currencystring余额单位,当前通常为 credits
wallet_account_idstring钱包账户 ID,用于对账与支持排查

接入建议

  • 对余额敏感的业务,建议在调用前先检查一次
  • 如果你有多条异步任务并发提交,最好在业务层也做额度预估
  • 余额页适合作为控制台、告警或自动化调度的辅助接口