Skip to main content
GET
Получите оставшийся и использованный баланс текущего API-ключа (токена). Этот эндпоинт используется для мониторинга использования отдельного токена.

Авторизация

string
обязательно
Все API-эндпоинты требуют аутентификации с помощью Bearer TokenПолучите свой API-ключ:Перейдите на страницу управления API-ключами, чтобы получить API-ключДобавьте его в заголовок запроса:

Эндпоинты

Оба эндпоинта обладают одинаковой функциональностью — вы можете использовать любой из них.

Ответ

boolean
Успешно ли выполнен запрос
string
Сообщение об ошибке (возвращается только при ошибке)
float
Оставшийся баланс токена (возвращается при успешном выполнении). Возвращает -1, когда unlimited_quota равно true
integer
Оставшиеся кредиты токена (возвращается при успешном выполнении). Возвращает -1, когда unlimited_quota равно true
float
Использованный баланс токена (возвращается при успешном выполнении)
integer
Использованные кредиты токена (возвращается при успешном выполнении)
boolean
Является ли квота токена безлимитной. true — безлимитная, false — ограниченная

Сценарии использования

  • Мониторинг расхода отдельного API-ключа
  • Отображение текущего баланса токена в вашем приложении
  • Настройка оповещений при падении баланса ниже порогового значения
Информация о единицах балансаЕдиница значения баланса зависит от конфигурации системы:
  • USD — доллары США
  • Credits — Кредиты
Токен с безлимитной квотойКогда для токена установлена безлимитная квота:
  • поле unlimited_quota возвращает true
  • поле remain_balance возвращает -1
  • поле remain_credits возвращает -1
  • токен не имеет ограничений по квоте и может использоваться без лимитов

Частые ошибки

Замечание по безопасностиВаш API-ключ — как пароль. Храните его в безопасности и не передавайте другим. В рабочей среде всегда используйте HTTPS.