Balance API

Balance API umożliwia pobranie aktualnego salda kredytów na Twoim koncie. Ten punkt końcowy zapewnia prosty sposób sprawdzania dostępnych kredytów, które są wykorzystywane do różnych usług Meshy.

GET/openapi/v1/balance

Pobierz saldo

Ten punkt końcowy pobiera aktualne saldo kredytów uwierzytelnionego użytkownika.

Zwraca

Zwraca obiekt zawierający aktualne saldo kredytów. W przypadku członków zespołu wartości te odzwierciedlają wspólną pulę kredytów zespołu.

Name
balance
Type
integer
Description
Liczba kredytów aktualnie dostępnych na Twoim koncie.
Name
monthly_credits
Type
integer
Description
Liczba pozostałych kredytów, które wygasają przy następnym miesięcznym odświeżeniu, zgodnie z monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Liczba kredytów, które nie wygasają, takich jak kredyty z zakupionych pakietów kredytów lub zdobytych nagród.
Name
monthly_resets_at
Type
timestamp
Description
Czas następnego miesięcznego odświeżenia kredytów, wyrażony jako znacznik czasu Unix w milisekundach. W tym momencie bieżące miesięczne kredyty wygasają i są uzupełniane, pod warunkiem że subskrypcja jest aktywna. Zwraca null, jeśli żadne odświeżenie nie jest zaplanowane.

Zazwyczaj balance jest równe monthly_credits + permanent_credits. Jeśli do wywołującego ma zastosowanie limit kredytów członka lub obszaru roboczego, wartość balance może być niższa.

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
}