Справочник API

Баланс

GET/v1/balance

Возвращает баланс аккаунта и сумму в USD, которую вызывающий API-ключ ещё может потратить. Бесплатно и только для чтения: без вызова модели, без списаний. Ключи с исчерпанным лимитом или истёкшим сроком тоже могут его вызывать; отклоняются только отключённые ключи.

#Параметры запроса

  • Authorizationheaderобязательно

    Bearer sk-YOUR_KEY. Тела и query-параметров нет.

balance — это весь кошелёк аккаунта; после расчёта за крупную задачу он может уйти в минус. available — сколько этот ключ может потратить прямо сейчас: меньшее из balance и собственного остатка лимита ключа, но не меньше нуля. key.remaining равно null, если у ключа нет собственного лимита; expires_at 0 означает, что срок действия не ограничен.

B2B-клиенты могут запрашивать его перед отправкой задач и предупреждать команду, когда available подходит к концу. Если включена подпись запросов, подписывайте этот вызов, как любой другой с этим ключом, используя путь /v1/balance.

#Связанные ошибки

  • 401Ключ отсутствует, недействителен или отключён — либо, если включена подпись запросов, подпись отсутствует или неверна.
  • 403Аккаунт отключён.
  • 500Не удалось получить баланс. Повторите через несколько секунд.

Полная таблица кодов ошибок →

#Пример запроса

curl https://www.aisplice.store/v1/balance \
  -H "Authorization: Bearer sk-YOUR_KEY"

#Ответ

response.json
{
  "object": "balance",
  "currency": "USD",
  "balance": 12.5,
  "available": 2,
  "key": {
    "name": "app",
    "unlimited": false,
    "remaining": 2,
    "used": 1,
    "expires_at": 0
  }
}

Проблема не решена?

Пришлите нам ID запроса или текст ошибки, и мы разберёмся.