Справочник APIGET /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Средства, зарезервированные ещё выполняющимися запросами. Когда каждый из них завершается, его резерв за вычетом фактической стоимости возвращается на баланс.
trialtrue, пока не зачислено первое пополнение аккаунта. У пробных аккаунтов более строгие лимиты.
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, если не помещается его собственный резерв, поэтому при небольшом остатке запрос с большим бюджетом вывода может быть отклонён. См. Аутентификация.
  • Лимиты расходов задаются для каждого ключа отдельно и не меняют баланс. Каждый ключ сообщает свои лимиты; баланс общий для всех ключей аккаунта.
  • Пополнить баланс можно в разделе Оплата. Средства на балансе не сгорают.