Balance API

Kiểm tra số tín dụng bạn có thể sử dụng, và số tín dụng sẽ hết hạn vào lần làm mới hàng tháng tiếp theo.

GET/openapi/v1/balance

Lấy số dư

Trả về số dư tín dụng của tài khoản sở hữu khóa API. Đối với nhóm có chung quỹ tín dụng, các giá trị trả về là của quỹ chung đó. Gọi endpoint này miễn phí.

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
}

Giá trị trả về

Name
balance
Type
integer
Description
Số tín dụng bạn có thể sử dụng. Thường là monthly_credits cộng với permanent_credits.
Giá trị này có thể thấp hơn nếu có giới hạn tín dụng thành viên hoặc giới hạn tín dụng không gian làm việc Enterprise áp dụng cho bạn. Chủ sở hữu và quản trị viên của nhóm không bị giới hạn này.
Name
monthly_credits
Type
integer
Description
Số tín dụng còn lại sẽ hết hạn vào lần làm mới hàng tháng tiếp theo, tại thời điểm monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Số tín dụng không bao giờ hết hạn, ví dụ từ các gói tín dụng bạn đã mua và từ các phần thưởng.
Name
monthly_resets_at
Type
timestamp
Description
Thời điểm làm mới tín dụng hàng tháng tiếp theo, tính bằng mili-giây Unix. Vào thời điểm đó, số tín dụng hàng tháng còn lại sẽ hết hạn, và nếu có đăng ký đang hoạt động sẽ được nạp lại. null khi không có lịch làm mới nào được đặt.

Các trường hợp lỗi

Name
401 - Unauthorized
Description
Khóa API bị thiếu hoặc không hợp lệ. Hãy kiểm tra header Authorization.
Name
429 - Too Many Requests
Description
Bạn đã gửi quá nhiều yêu cầu. Hãy chờ số giây được nêu trong Retry-After, sau đó thử lại.