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
}