Перейти к основному содержанию
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Получите оставшийся и использованный баланс текущего API-ключа (токена). Этот эндпоинт используется для мониторинга использования отдельного токена. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
Авторизация

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

​
Эндпоинты

GET /v1/balance
GET /balance
Оба эндпоинта обладают одинаковой функциональностью — вы можете использовать любой из них.

​
Ответ

​
success
boolean
Успешно ли выполнен запрос
​
message
string
Сообщение об ошибке (возвращается только при ошибке)
​
remain_balance
float
Оставшийся баланс токена (возвращается при успешном выполнении). Возвращает -1, когда unlimited_quota равно true
​
used_balance
float
Использованный баланс токена (возвращается при успешном выполнении)
​
unlimited_quota
boolean
Является ли квота токена безлимитной. true — безлимитная, false — ограниченная

​
Сценарии использования

  • Мониторинг расхода отдельного API-ключа
  • Отображение текущего баланса токена в вашем приложении
  • Настройка оповещений при падении баланса ниже порогового значения
Информация о единицах балансаЕдиница значения баланса зависит от конфигурации системы:
  • USD — доллары США
  • CNY — китайские юани
  • Tokens — количество токенов
Токен с безлимитной квотойКогда для токена установлена безлимитная квота:
  • поле unlimited_quota возвращает true
  • поле remain_balance возвращает -1
  • токен не имеет ограничений по квоте и может использоваться без лимитов

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

Сообщение об ошибкеПричинаРешение
No Authorization headerЗаголовок Authorization не указанДобавьте заголовок Authorization: Bearer sk-xxxxx
Failed to get token infoТокен не существует или был удалёнПроверьте корректность ключа токена
Замечание по безопасностиВаш API-ключ — как пароль. Храните его в безопасности и не передавайте другим. В рабочей среде всегда используйте HTTPS.