Balance API

Проверьте, сколько кредитов вы можете потратить и сколько из них истечёт при следующем ежемесячном обновлении.

GET/openapi/v1/balance

Получить баланс

Возвращает баланс кредитов аккаунта, которому принадлежит API-ключ. В команде с общим пулом кредитов возвращаются значения этого пула. Вызов этого эндпоинта бесплатен.

Request

GET

/openapi/v1/balance

curl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "balance": 1000,
  "monthly_credits": 600,
  "permanent_credits": 400,
  "monthly_resets_at": 1793491200000
}

Возвращает

Name
balance
Type
integer
Description
Количество кредитов, которые вы можете потратить. Обычно это monthly_credits плюс permanent_credits.
Значение может быть ниже, если к вам применяется лимит кредитов участника или лимит кредитов рабочей области Enterprise. На владельцев команды и администраторов такой лимит не распространяется.
Name
monthly_credits
Type
integer
Description
Количество оставшихся кредитов, которые истекают при следующем ежемесячном обновлении, в момент monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Количество кредитов, которые не истекают, например из купленных пакетов кредитов и наград.
Name
monthly_resets_at
Type
timestamp
Description
Время следующего ежемесячного обновления кредитов, в миллисекундах Unix. В этот момент оставшиеся ежемесячные кредиты истекают, а активная подписка пополняет их. null, если обновление не запланировано.

Варианты сбоя

Name
401 - Unauthorized
Description
API-ключ отсутствует или недействителен. Проверьте заголовок Authorization.
Name
429 - Too Many Requests
Description
Вы отправили слишком много запросов. Подождите количество секунд, указанное в Retry-After, затем повторите попытку.