Skip to main content
GET
  • Запрос остатка и использованной квоты текущего API ключа
  • Мониторинг использования одного токена
  • Поддержка CORS
  • Мониторинг баланса в реальном времени
Получение остатка и использованного баланса текущего API ключа (токена). Этот эндпоинт используется для мониторинга использования одного токена. Также возвращаются поля кредитов с фиксированной конвертацией 1 USD = 200 credits.

Авторизация

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

Эндпоинты

Оба эндпоинта имеют одинаковую функциональность.

Ответ

boolean
Успешность запроса
string
Сообщение об ошибке (только при неудаче)
float
Остаток баланса токена (возвращается при успехе). Возвращает -1 когда unlimited_quota равно true
float
Использованный баланс токена (возвращается при успехе)
float
Оставшиеся credits токена (возвращается при успехе). Рассчитывается по курсу 1 USD = 200 credits
float
Использованные credits токена (возвращается при успехе)
float
Курс конвертации credits. Сейчас возвращает 200
boolean
Имеет ли токен безлимитную квоту. true означает безлимитную, false означает ограниченную

Применение

  • Мониторинг потребления одного API ключа
  • Отображение текущего баланса токена в приложении
  • Настройка оповещений при низком балансе
Информация о единицах балансаЕдиница измерения баланса зависит от конфигурации системы:
  • USD - Доллары США
  • CNY - Китайские юани
  • Tokens - Количество токенов
Для стабильной интеграции используйте remain_credits и used_credits, если нужны значения в credits. Эти поля всегда используют 1 USD = 200 credits и не зависят от настройки отображения баланса.
Безлимитный токенКогда токен имеет безлимитную квоту:
  • Поле unlimited_quota возвращает true
  • Поле remain_balance возвращает -1
  • Токен не имеет ограничений квоты

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

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