API запроса баланса

Обзор API

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

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

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

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

Найдите System Token

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

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

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

Информация об API

Пункт	Описание
URL API	`https://api.apiyi.com/api/user/self`
Метод	`GET`
Аутентификация	Заголовок Authorization
Формат ответа	JSON

Сведения о запросе

Заголовки запроса

Имя заголовка	Обязательно	Описание
`Authorization`	Да	Токен доступа API, формат: строка прямого токена
`Accept`	Нет	Рекомендуется: `application/json`
`Content-Type`	Нет	Рекомендуется: `application/json`

Параметры запроса

Это GET-запрос и не требует никаких параметров тела запроса.

Детали ответа

Пример успешного ответа

{
  "success": true,
  "message": null,
  "data": {
    "id": 19489,
    "username": "testnano",
    "display_name": "testnano",
    "role": 1,
    "status": 1,
    "email": "",
    "quota": 24997909,
    "used_quota": 10027091,
    "request_count": 339,
    "group": "ceshi",
    "aff_code": "ZM0H",
    "inviter_id": 0,
    "access_token": "...",
    "ModelFixedPrice": [...]
  }
}

Ключевые поля ответа

Имя поля	Тип	Описание
`success`	Boolean	Был ли запрос успешным
`message`	String	Сообщение об ошибке (null при успехе)
`data.username`	String	Имя пользователя
`data.display_name`	String	Отображаемое имя
`data.quota`	Integer	Оставшаяся квота (текущий доступный баланс в единицах квоты)
`data.used_quota`	Integer	Использованная квота (в единицах квоты)
`data.request_count`	Integer	Общее количество запросов
`data.group`	String	Группа пользователя
`data.ModelFixedPrice`	Array	Список цен моделей (можно игнорировать)

Преобразование квоты

Правило преобразования

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

{
  "success": false,
  "message": "Unauthorized"
}

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

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

{
  "success": false,
  "message": "Forbidden"
}

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

Примеры кода

Пример cURL

curl --compressed 'https://api.apiyi.com/api/user/self' \
  -H 'Accept: application/json' \
  -H 'Authorization: YOUR_TOKEN_HERE' \
  -H 'Content-Type: application/json'

Важно: параметр --compressed обязателен, потому что API возвращает gzip-сжатое содержимое; иначе вы получите нечитаемый вывод.

Быстрая проверка (замените YOUR_TOKEN_HERE):

export APIYI_TOKEN='YOUR_TOKEN_HERE'

curl --compressed -s 'https://api.apiyi.com/api/user/self' \
  -H 'Accept: application/json' \
  -H "Authorization: $APIYI_TOKEN" \
  -H 'Content-Type: application/json' | \
  jq '.data | {quota, used_quota, request_count}'

Примечание: параметр -s скрывает индикатор прогресса, а --compressed автоматически распаковывает gzip-ответ

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

import requests

{/* Configuration */}
url = "https://api.apiyi.com/api/user/self"
authorization = "YOUR_TOKEN_HERE"  # Replace with your token

{/* Request headers */}
headers = {
    'Accept': 'application/json',
    'Authorization': authorization,
    'Content-Type': 'application/json'
}

{/* Send request */}
response = requests.get(url, headers=headers, timeout=10)

{/* Check response */}
if response.status_code == 200:
    data = response.json()
    user_data = data['data']

    {/* Extract key information */}
    quota = user_data['quota']
    used_quota = user_data['used_quota']
    request_count = user_data['request_count']

    {/* Calculate USD amounts */}
    {/* Note: quota represents current remaining balance */}
    remaining_usd = quota / 500000
    used_usd = used_quota / 500000

    {/* Print results */}
    print(f"Remaining quota: ${remaining_usd:.2f} USD ({quota:,} quota)")
    print(f"Used: ${used_usd:.2f} USD ({used_quota:,} quota)")
    print(f"Request count: {request_count:,} times")
else:
    print(f"Request failed: HTTP {response.status_code}")
    print(response.text)

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

Мы предоставляем полный оптимизированный скрипт quota_optimized.py со следующими возможностями:

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

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

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

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

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

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

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

Автоматический расчет суммы в USD

Использование:

{/* Method 1: Using environment variable (recommended) */}
export APIYI_TOKEN='YOUR_TOKEN_HERE'
python quota_optimized.py

{/* Method 2: Command line argument */}
python quota_optimized.py 'YOUR_TOKEN_HERE'

Пример вывода:

============================================================
📊 APIYI Account Balance Information
============================================================
Username: testnano (testnano)
------------------------------------------------------------
Remaining quota: 24,997,909 quota ($49.99 USD)
Used:           10,027,091 quota ($20.05 USD)
Request count: 339 times
============================================================
💡 Conversion: 500,000 quota = $1.00 USD
============================================================

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

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

Пожалуйста, обратитесь к разделу «Как получить Authorization token» выше или перейдите на страницу профиля в консоли, чтобы получить системный token.

Расходует ли запрос баланса квоту?

Нет, API запроса баланса не расходует вашу квоту.

Как часто можно запрашивать баланс?

Мы рекомендуем интервал запросов не менее 1 секунды, чтобы избежать срабатывания лимитов запросов.

Для чего используется поле ModelFixedPrice?

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

Что означает поле квоты?

Поле quota обозначает текущий оставшийся баланс. Если quota равно 0 или близко к 0, баланс вашей учетной записи недостаточен и требует пополнения.

Почему curl возвращает искаженный текст или jq сообщает об ошибках?

Проблема: При выполнении curl возвращает искаженный текст или jq сообщает об ошибке “Invalid numeric literal”Причина: API возвращает gzip-сжатое содержимое (Content-Encoding: gzip), а curl не выполняет автоматическую распаковку.Решение: Добавьте параметр --compressed, чтобы curl автоматически выполнял распаковку:

{/* ✅ Correct (with --compressed) */}
curl --compressed 'https://api.apiyi.com/api/user/self' \
  -H 'Authorization: YOUR_TOKEN' | jq

{/* ❌ Wrong (missing --compressed) */}
curl 'https://api.apiyi.com/api/user/self' \
  -H 'Authorization: YOUR_TOKEN' | jq

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

Напоминания по безопасности

Никогда не прописывайте Authorization tokens непосредственно в коде
Используйте переменные окружения или файлы конфигурации для управления конфиденциальной информацией
Не коммитьте код, содержащий tokens, в публичные репозитории

Лимиты запросов

Устанавливайте разумный request timeout (рекомендуется: 10 секунд)
Избегайте слишком частых запросов

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

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

Основы

Базовый API

Image API (официальный)

Video API (официальный)

API мультимодального понимания

Текстовый API

API запроса баланса

Обзор API

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

Информация об API

Сведения о запросе

Заголовки запроса

Параметры запроса

Детали ответа

Пример успешного ответа

Ключевые поля ответа

Преобразование квоты

Правило преобразования

Ответы на ошибки

HTTP 401 - Ошибка аутентификации

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

Примеры кода

Пример cURL

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

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

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

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

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

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

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

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

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

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

​Обзор API

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

​Информация об API

​Сведения о запросе

​Заголовки запроса

​Параметры запроса

​Детали ответа

​Пример успешного ответа

​Ключевые поля ответа

​Преобразование квоты

Правило преобразования

​Ответы на ошибки

​HTTP 401 - Ошибка аутентификации

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

​Примеры кода

​Пример cURL

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

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

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

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

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

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

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

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

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

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

Обзор API

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

Информация об API

Сведения о запросе

Заголовки запроса

Параметры запроса

Детали ответа

Пример успешного ответа

Ключевые поля ответа

Преобразование квоты

Ответы на ошибки

HTTP 401 - Ошибка аутентификации

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

Примеры кода

Пример cURL

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

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

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

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