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 คีย์ หรือ API คีย์ไม่ถูกต้อง ตรวจสอบ header Authorization
Name
429 - Too Many Requests
Description
คุณส่งคำขอมากเกินไป รอตามจำนวนวินาทีที่ระบุใน Retry-After แล้วลองใหม่อีกครั้ง