API tham khảo

Kiểm tra số dư

API xem số dư tài khoản và quota còn lại của từng API key, xác thực chỉ bằng API key.

Endpoint này cho bạn đọc số dư ngay trong code, chỉ cần API key — không cần đăng nhập hay token riêng. Hữu ích để app tự cảnh báo khi sắp hết quota.

Endpoint

GET
GET https://cheapkeyai.shop/v1/balance

Yêu cầu

TênVị tríBắt buộcMô tả
Authorizationheader`Bearer sk-your-api-key-here`

Ví dụ

cURL
curl https://cheapkeyai.shop/v1/balance \
  -H "Authorization: Bearer sk-your-api-key-here"

Phản hồi 200

Response
{
  "success": true,
  "message": "",
  "data": {
    "user_quota": 1500000,
    "user_balance": 3,
    "user_used_quota": 250000,
    "user_used_balance": 0.5,
    "quota_per_unit": 500000,
    "key_name": "my-app-key",
    "key_remain_quota": 400000,
    "key_used_quota": 90000,
    "key_unlimited_quota": false,
    "key_expired_time": -1
  }
}

Giải thích các trường

TrườngÝ nghĩa
user_quotaSố dư còn lại của tài khoản, tính bằng quota
user_balanceCùng số dư đó nhưng quy ra tiền (`user_quota / quota_per_unit`)
user_used_quotaTổng quota đã dùng của tài khoản
user_used_balanceTổng đã dùng, quy ra tiền
quota_per_unitHệ số quy đổi giữa quota và tiền
key_nameTên của API key đang gọi
key_remain_quotaQuota còn lại của riêng key này (chỉ có khi key bị giới hạn quota)
key_used_quotaQuota key này đã dùng
key_unlimited_quota`true` nếu key không bị giới hạn quota riêng
key_expired_timeThời điểm key hết hạn (Unix seconds), `-1` là không hết hạn

Lỗi 401

Thiếu hoặc sai API key
{
  "error": {
    "message": "Invalid token",
    "type": "new_api_error"
  }
}