Обзор API
API запроса баланса получает текущий расход квоты вашего аккаунта, включая общую квоту, использованную квоту, оставшийся баланс и количество запросов. Этот API помогает вам легко отслеживать баланс аккаунта, обеспечивая заблаговременное и гибкое управление уведомлениями о балансе.Как получить token Authorization
Этот API выполняет аутентификацию с помощью персонального token доступа (начинающегося сnap_). Он отличается от API Key, который используется для вызова моделей.
1
Откройте раздел Personal Access Tokens
Перейдите на страницу своего профиля по адресу
api.apiyi.com/account/profile. В блоке Account Options нажмите Personal Access Tokens → Create Token.2
Выберите разрешения
Для этого API требуется только Profile · Read. Срок действия по умолчанию составляет 30 дней, поэтому мы рекомендуем выбрать более длительный период.
3
Сохраните token
Скопируйте token сразу после создания и укажите его в заголовке
Authorization.
Информация об API
Детали запроса
Заголовки запроса
Параметры запроса
Это GET-запрос, и он не требует параметров в теле запроса.
Детали ответа
Пример успешного ответа
Ключевые поля ответа
Преобразование квоты
Правило преобразования
500,000 quota = $1.00 USD
- Сумма в USD = quota ÷ 500,000
- Оставшаяся квота = quota (quota представляет текущий оставшийся баланс)
- Оставшиеся USD = quota ÷ 500,000
quota: 24997909→ $49.99 USD (текущий оставшийся баланс)used_quota: 10027091→ $20.05 USD (использованная сумма)
Ответы с ошибками
HTTP 401 - Ошибка аутентификации
HTTP 403 - Доступ запрещен
Примеры кода
Пример cURL
Примечание: параметр
-s скрывает индикатор выполнения, а --compressed автоматически распаковывает gzip-ответПример на Python (базовый)
Пример на Python (оптимизированный)
По сравнению с базовым примером сюда добавлено следующее:Обработка ошибок
Полноценная обработка исключений и перехват ошибок
Переменные окружения
Безопасное управление token, предотвращение хардкода
Форматированный вывод
Красивое табличное отображение и форматирование чисел
Автоматическая конвертация
Автоматический расчет суммы в USD
quota.py, и он готов к запуску:
FAQ
Расходует ли запрос баланса квоту?
Расходует ли запрос баланса квоту?
Нет, API запроса баланса не расходует вашу квоту.
Как часто можно запрашивать баланс?
Как часто можно запрашивать баланс?
Мы рекомендуем интервал между запросами не менее 1 секунды, чтобы избежать срабатывания лимитов запросов.
Для чего нужно поле ModelFixedPrice?
Для чего нужно поле ModelFixedPrice?
Это поле возвращает информацию о ценах на различные модели AI. Вы можете проигнорировать его, если вам нужны только сведения о балансе.
Что означает поле quota?
Что означает поле quota?
Поле
quota представляет собой текущий остаток баланса. Если quota равно 0 или близко к 0, баланс вашего аккаунта недостаточен и требует пополнения.Почему curl возвращает нечитаемый текст или jq сообщает об ошибках?
Почему curl возвращает нечитаемый текст или jq сообщает об ошибках?
Проблема: При выполнении curl возвращается нечитаемый текст или jq выдает ошибку «Invalid numeric literal»Причина: API возвращает содержимое, сжатое с помощью gzip (
Content-Encoding: gzip), и curl не распаковывает его автоматически.Решение: Добавьте параметр --compressed, чтобы curl распаковывал ответ автоматически:Важные примечания
Лимиты запросов
- Устанавливайте разумный request timeout (рекомендуется: 10 секунд)
- Избегайте слишком частых запросов
Рекомендации по обработке исключений
- Всегда обрабатывайте сетевые исключения, timeout’ы и ошибки аутентификации
- Логируйте ошибки для более простой диагностики
Примечания к формату ответа
- API возвращает содержимое, сжатое gzip; curl требует опцию
--compressed - Библиотека requests в Python автоматически обрабатывает распаковку gzip без дополнительной настройки