Balance API

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

GET/openapi/v1/balance

Получение баланса

Этот эндпоинт возвращает текущий баланс кредитов для аутентифицированного пользователя.

Возвращаемые данные

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

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

Обычно balance равен monthly_credits + permanent_credits. Если к вызывающему пользователю применяется лимит кредитов участника или рабочей области, значение balance может быть ниже.

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
}