跳转到内容
中文

查询余额

GET /v1/account/balance 返回账号级余额:剩余可用额度和累计已用金额(单位 USD)。可以把它接入自己的监控系统、充值提醒或内部运维面板,在请求开始报错之前及时发现余额不足。

账号下任意一把有效 API key 都可以。key 在这里只作为凭证,额度耗尽的 key 同样可以查余额,余额见底后仍能查到正是本接口的用途。

Terminal window
curl https://api.hiapi.ai/v1/account/balance \
-H "Authorization: Bearer $HIAPI_API_KEY"

无请求体,无查询参数。

{"object":"account_balance","balance_usd":9.98,"used_usd":194.56,"currency":"USD"}
字段类型说明
objectstring固定为 account_balance。
balance_usdnumber账号剩余余额,单位 USD。
used_usdnumber账号注册以来的累计已用金额,单位 USD。
currencystring固定为 USD。单位固定,不随站点展示设置变化。

余额由平台内部额度单位换算而来,存在轻微的浮点舍入属正常现象。

HTTP含义
401API key 缺失、无效、已禁用或已过期。
403请求来源 IP 不在该 key 的允许 IP 列表内。
429触发限流:每账号每分钟 60 次。退避后重试。
500内部错误,如数据库故障或计费配置异常。

余额查询免费:不消耗任何额度,限流额度独立于生成请求。

HiAPI 也保留了 OpenAI 兼容的端点:

  • GET /v1/dashboard/billing/subscription 返回的是调用者这把 key 自己的额度上限
  • GET /v1/dashboard/billing/usage 是这把 key 的用量

这两个端点跟 key 自身额度走,且字段名沿用 OpenAI 的旧命名,用来做账号余额监控容易误读。新集成请优先使用 /v1/account/balance。