Balance API

Sprawdź, ile kredytów możesz wydać i ile z nich wygaśnie przy najbliższym miesięcznym odnowieniu.

GET/openapi/v1/balance

Pobierz saldo

Zwraca saldo kredytów konta, do którego należy klucz API. W zespole ze wspólną pulą kredytów zwracane są wartości tej puli. Wywołanie tego punktu końcowego jest bezpłatne.

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
}

Zwraca

Name
balance
Type
integer
Description
Liczba kredytów, które możesz wydać. Zazwyczaj jest to suma monthly_credits i permanent_credits.
Wartość ta może być niższa, jeśli dotyczy Cię limit kredytów członka zespołu lub limit kredytów obszaru roboczego Enterprise. Właściciele i administratorzy zespołu nie podlegają takiemu limitowi.
Name
monthly_credits
Type
integer
Description
Liczba pozostałych kredytów, które wygasną przy najbliższym miesięcznym odnowieniu, wskazanym przez monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Liczba kredytów, które nie wygasają, np. pochodzących z zakupionych pakietów kredytów oraz z nagród.
Name
monthly_resets_at
Type
timestamp
Description
Czas najbliższego miesięcznego odnowienia kredytów, w milisekundach Unix. W tym momencie pozostałe kredyty miesięczne wygasają, a aktywna subskrypcja uzupełnia je na nowo. null, gdy żadne odnowienie nie jest zaplanowane.

Tryby niepowodzenia

Name
401 - Unauthorized
Description
Brak klucza API lub jest on nieprawidłowy. Sprawdź nagłówek Authorization.
Name
429 - Too Many Requests
Description
Wysłano zbyt wiele żądań. Odczekaj liczbę sekund podaną w Retry-After, a następnie spróbuj ponownie.