Skip to main content

Обзор API

API запроса баланса получает текущий расход квоты вашего аккаунта, включая общую квоту, использованную квоту, оставшийся баланс и количество запросов. Этот API помогает вам легко отслеживать баланс аккаунта, обеспечивая заблаговременное и гибкое управление уведомлениями о балансе.

Как получить Authorization Token

1

Открыть консоль

Перейдите на api.apiyi.com/account/profile, чтобы открыть страницу профиля
2

Найдите System Token

Найдите внизу страницы раздел “Параметры учетной записи - System Token”
3

Сгенерировать AccessToken

Введите пароль учетной записи, чтобы получить AccessToken, который можно использовать для последующих API-запросов
Получить System Token

Информация об 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 - Ошибка аутентификации

Причина: Authorization token недействителен или срок его действия истек Решение: Проверьте и обновите ваш API token

HTTP 403 - Доступ запрещен

Причина: У текущего token нет разрешения на доступ к этому API Решение: Обратитесь к администратору, чтобы проверить настройки разрешений

Примеры кода

Пример cURL

Важно: Параметр --compressed обязателен, потому что API возвращает gzip-сжатое содержимое, иначе вы получите искажённый вывод.
Быстрая проверка (замените YOUR_TOKEN_HERE):
Примечание: Параметр -s скрывает полосу прогресса, --compressed автоматически распаковывает gzip-ответ

Пример Python (Базовый)

Пример Python (Оптимизированный)

Это добавляет следующее к базовому примеру:

Обработка ошибок

Полная обработка исключений и захват ошибок

Переменные окружения

Безопасное управление token, избегайте хардкода

Форматированный вывод

Красивое отображение таблиц и форматирование чисел

Автоматическое преобразование

Автоматический расчет суммы в USD
Сохраните код ниже как quota.py, и он будет готов к запуску:
Использование:
Пример вывода:

Часто задаваемые вопросы

Обратитесь к разделу «Как получить Authorization token» выше или перейдите на страницу профиля в консоли, чтобы получить системный token.
Нет, API запроса баланса не расходует вашу квоту.
Мы рекомендуем интервал запросов не менее 1 секунды, чтобы не вызывать лимиты запросов.
Это поле возвращает информацию о тарификации для различных AI-моделей. Вы можете не обращать на него внимания, если вам нужна только информация о балансе.
Поле quota показывает текущий оставшийся баланс. Если quota равно 0 или близко к 0, ваш баланс недостаточен и его нужно пополнить.
Проблема: При выполнении curl возвращается искаженный текст, или jq сообщает «Invalid numeric literal»Причина: API возвращает содержимое, сжатое gzip (Content-Encoding: gzip), а curl не распаковывает его автоматически.Решение: Добавьте опцию --compressed, чтобы curl автоматически распаковывал данные:

Важные примечания

Напоминания по безопасности
  • Никогда не прописывайте Authorization tokens непосредственно в коде
  • Используйте переменные окружения или файлы конфигурации для управления конфиденциальной информацией
  • Не коммитьте код, содержащий tokens, в публичные репозитории
Лимиты запросов
  • Устанавливайте разумный request timeout (рекомендуется: 10 секунд)
  • Избегайте слишком частых запросов

Рекомендации по обработке исключений

  • Всегда обрабатывайте сетевые исключения, timeout’ы и ошибки аутентификации
  • Логируйте ошибки для более простой диагностики

Примечания к формату ответа

  • API возвращает содержимое, сжатое gzip; curl требует опцию --compressed
  • Библиотека requests в Python автоматически обрабатывает распаковку gzip без дополнительной настройки