Перейти к основному содержанию

Обзор 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.
Создание персонального token доступа: имя, срок действия, белый список IP и разрешения
Устаревшие системные tokens планируется вывести из эксплуатации 2026-11-11 (UTC+8). AccessTokens, созданные в «Account Options - System Token», продолжат работать до этой даты. После нее они будут возвращать 401 ACCESS_TOKEN_LEGACY_RETIRED. Мы проанализируем использование и, возможно, продлим этот срок, но рекомендуем перейти на персональный token доступа уже сейчас. Достаточно просто заменить значение в заголовке. Ваш код менять не потребуется. Подробнее о сроках действия, белых списках IP и разрешениях см. в разделе Что такое персональный 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 - Ошибка аутентификации

Причина: Token недействителен, истек или удален. Смена пароля учетной записи, двухфакторной аутентификации или passkey отзывает каждый персональный token доступа. Решение: Создайте новый персональный token доступа в консоли. Два других ответа 401 содержат явное сообщение:

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

Причина: У персонального token доступа отсутствует разрешение Profile · Read. Решение: Создайте новый token с этим разрешением. Изменить разрешения после создания невозможно.

Примеры кода

Пример cURL

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

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

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

По сравнению с базовым примером сюда добавлено следующее:

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

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

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

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

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

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

Автоматическая конвертация

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

FAQ

Следуйте инструкциям в разделе «Как получить token Authorization» выше: создайте персональный access token на странице своего профиля и выберите «Profile · Read». Устаревшие системные tokens планируется вывести из эксплуатации 2026-11-11 (UTC+8). См. Что такое персональный access 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 без дополнительной настройки