API 参考GET /v1/balance

GET /v1/balance

返回该 API 密钥所属账户的余额,以及该密钥各项消费上限的剩余额度。可以用它在你的应用中显示剩余额度、在批量任务耗尽额度前充值,或在智能体遇到 402 之前将其暂停。

占位符:$API_BASE 为 https://api.abliteratedllm.dev/v1,$API_ORIGIN 为 https://api.abliteratedllm.dev,$YOUR_KEY 为你的 API 密钥。

bash
curl $API_BASE/balance -H "Authorization: Bearer $YOUR_KEY"
json
{
  "balance_usd": "12.345678",
  "held_usd": "0.000000",
  "trial": false,
  "available_usd": "12.345678",
  "key_daily_remaining_usd": "4.500000",
  "key_monthly_remaining_usd": null,
  "key_lifetime_remaining_usd": "40.000000"
}

字段

字段含义
balance_usd可用于新请求的额度,以美元计,保留 6 位小数。运行中请求预扣的额度已被扣除。
held_usd仍在运行的请求预留的额度。每个请求结束时,其预扣金额减去实际费用后返还到余额。
trial在账户首笔充值到账之前为 true。试用账户的限制更严格。
available_usd账户额度减去运行中请求的预扣。预扣在发生时就从余额中扣除,因此该值始终等于 balance_usd。它由账户下所有密钥共享;密钥的上限可能会进一步限制它(见下方字段)。
key_daily_remaining_usd该密钥今天(UTC)每日上限的剩余额度;密钥没有每日上限时为 null。
key_monthly_remaining_usd该密钥本自然月(UTC)每月上限的剩余额度;没有每月上限时为 null。
key_lifetime_remaining_usd该密钥累计预算的剩余额度;没有累计预算时为 null。

金额为十进制字符串,以免损失精度。将其解析为十进制数,而不是浮点数。

说明

  • balance_usd 可能会略低于零:请求总是按实际用量计费,即使超出其预扣。当余额低于下一个请求的预扣时,请求会以 402 insufficient_balance 失败,直到你充值。
  • 没有请求运行时,held_usd 通常为 "0.000000"。从未结束的请求的预扣会在 15 分钟后自动释放。
  • 剩余上限等于上限减去该密钥在当期的已结算消费及其运行中请求的预扣,与网关转发请求前检查的总和相同。它不会低于零。当请求自身的预扣放不下时,请求会以 402 key_spend_cap_reached 失败,因此即使还剩少量额度,输出预算较大的请求仍可能被拒绝。见认证。
  • 消费上限按密钥设置,不会改变余额。每个密钥报告自己的上限;余额由账户下所有密钥共享。
  • 在账单中充值。额度永不过期。