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, а потім повторіть спробу.