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新しいリクエストに使えるクレジット(USD、小数点以下6桁)。実行中のリクエストが仮押さえしている分は、すでに差し引かれています。
held_usdまだ実行中のリクエストが確保しているクレジット。各リクエストが終わると、仮押さえ額から実際のコストを引いた分が残高に戻ります。
trialアカウントの初回チャージが反映されるまではtrueです。トライアルアカウントにはより厳しい制限があります。
available_usdアカウントのクレジットから、実行中のリクエストが仮押さえしている分を引いた額。仮押さえは確保された時点で残高から差し引かれるため、この値は常にbalance_usdと等しくなります。アカウントのすべてのキーで共有されますが、キーの上限によってさらに制限される場合があります(下記のフィールド)。
key_daily_remaining_usdこのキーの本日(UTC)の1日の上限の残り。キーに1日の上限がない場合はnull。
key_monthly_remaining_usdこのキーの今月(UTC基準の暦月)の月間上限の残り。上限がない場合はnull。
key_lifetime_remaining_usdこのキーの累計予算の残り。予算がない場合はnull。

金額は、精度が失われないよう10進数の文字列になっています。浮動小数点数ではなく、10進数として解析してください。

注意事項

  • balance_usdは、わずかに0を下回ることがあります。リクエストには、仮押さえ額を超える場合でも常に実際の使用量が課金されるためです。残高が次のリクエストの仮押さえ額を下回っている間は、チャージするまでリクエストは402 insufficient_balanceで失敗します。
  • 何も実行されていないとき、held_usdは通常"0.000000"です。終了しないリクエストの仮押さえは、15分後に自動で解除されます。
  • 上限の残りは、上限からそのキーの期間内の確定済みの利用額と実行中のリクエストの仮押さえ額を引いた値で、ゲートウェイがリクエストを転送する前に確認するのと同じ合計です。0を下回ることはありません。リクエスト自体の仮押さえ額が収まらない場合は402 key_spend_cap_reachedで失敗するため、残りが少ないと、出力予算の大きいリクエストは拒否されることがあります。認証を参照してください。
  • 支出上限はキーごとのもので、残高には影響しません。各キーは自身の上限を報告し、残高はアカウントのすべてのキーで共有されます。
  • チャージは支払いで行います。クレジットに有効期限はありません。