Balance API

Periksa berapa banyak kredit yang dapat Anda belanjakan, dan berapa banyak di antaranya yang akan kedaluwarsa pada pembaruan bulanan berikutnya.

GET/openapi/v1/balance

Dapatkan saldo

Mengembalikan saldo kredit dari akun yang memiliki kunci API tersebut. Pada tim dengan pool kredit bersama, nilai yang ditampilkan adalah nilai dari pool tersebut. Memanggil endpoint ini gratis.

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
}

Returns

Name
balance
Type
integer
Description
Jumlah kredit yang dapat Anda belanjakan. Biasanya merupakan monthly_credits ditambah permanent_credits.
Nilainya bisa lebih rendah jika ada batas kredit anggota atau batas kredit ruang kerja Enterprise yang berlaku untuk Anda. Pemilik tim dan admin tidak memiliki batasan seperti itu.
Name
monthly_credits
Type
integer
Description
Jumlah sisa kredit yang akan kedaluwarsa pada pembaruan bulanan berikutnya, pada monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Jumlah kredit yang tidak kedaluwarsa, misalnya dari paket kredit yang Anda beli dan dari reward.
Name
monthly_resets_at
Type
timestamp
Description
Waktu pembaruan kredit bulanan berikutnya, dalam milidetik Unix. Pada waktu tersebut, sisa kredit bulanan akan kedaluwarsa, dan langganan yang aktif akan mengisinya kembali. null jika tidak ada pembaruan yang dijadwalkan.

Failure modes

Name
401 - Unauthorized
Description
Kunci API tidak ada atau tidak valid. Periksa header Authorization.
Name
429 - Too Many Requests
Description
Anda mengirim terlalu banyak permintaan. Tunggu selama jumlah detik yang tertera di Retry-After, lalu coba lagi.