API Baki

Semak berapa banyak kredit yang boleh anda belanjakan, dan berapa banyak daripadanya akan tamat tempoh pada pembaharuan bulanan seterusnya.

GET/openapi/v1/balance

Dapatkan baki

Mengembalikan baki kredit akaun yang memiliki kunci API tersebut. Pada pasukan dengan kumpulan kredit yang dikongsi, nilai yang ditunjukkan adalah nilai bagi kumpulan tersebut. Memanggil endpoint ini adalah percuma.

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
}

Nilai Pulangan

Name
balance
Type
integer
Description
Bilangan kredit yang boleh anda belanjakan. Biasanya ia adalah monthly_credits ditambah permanent_credits.
Ia boleh menjadi lebih rendah apabila had kredit ahli atau had kredit ruang kerja Enterprise dikenakan kepada anda. Pemilik dan pentadbir pasukan tidak mempunyai had sedemikian.
Name
monthly_credits
Type
integer
Description
Bilangan kredit baki yang akan tamat tempoh pada pembaharuan bulanan seterusnya, pada monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Bilangan kredit yang tidak akan tamat tempoh, contohnya daripada pek kredit yang anda beli dan daripada ganjaran.
Name
monthly_resets_at
Type
timestamp
Description
Masa pembaharuan kredit bulanan seterusnya, dalam milisaat Unix. Pada masa tersebut, baki kredit bulanan akan tamat tempoh, dan langganan aktif akan mengisinya semula. null apabila tiada pembaharuan dijadualkan.

Mod kegagalan

Name
401 - Unauthorized
Description
Kunci API tiada atau tidak sah. Semak header Authorization.
Name
429 - Too Many Requests
Description
Anda telah menghantar terlalu banyak permintaan. Tunggu selama bilangan saat yang dinyatakan dalam Retry-After, kemudian cuba semula.