API Key

Lấy thông tin API key hiện tại

Trả về trạng thái của key trong header Authorization: hạn mức, số dư còn lại, kỳ đặt lại, thời hạn, loại key, chi phí và số lượng request thành công, cùng bậc giới hạn tốc độ. Key thông thường trả về số liệu của chính key đó với usage_scope: key; Management Key của tổ chức trả về số liệu của toàn tổ chức với usage_scope: organization, cùng tổng số với dashboard của tổ chức. Ranh giới ngày, tuần và tháng đều theo UTC: 00:00 UTC, 00:00 UTC thứ Hai và 00:00 UTC ngày đầu tháng. Nếu key tổ chức không có hạn mức riêng, limit_remaining, is_free_tier và bậc giới hạn tốc độ dùng số dư tổ chức. Dùng GET /v1/credits để xem số dư tài khoản. Ví dụ bên dưới dùng management key để xem tổng tổ chức rồi xem mức sử dụng của từng key. Khi có hạn mức riêng, limit_remaining bằng hạn mức trừ chi phí của key trong kỳ đặt lại theo ngày, tuần hoặc tháng; nếu không có hạn mức riêng thì dùng số dư tài khoản mà key sử dụng, còn key tổ chức dùng số dư tổ chức.

GET/v1/key

Xác thực

Authorizationbắt buộc

string · header

API key dưới dạng bearer token trong header Authorization.

GET /v1/key

1
2
3
4
5
6
7
8
9
10
11
curl https://api.bazaarlink.ai/v1/key \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

# Abbreviated response (fake values):
# {"data":{"usage":18.42,"usage_scope":"organization","requests":73}}

curl https://api.bazaarlink.ai/v1/keys \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

# Abbreviated response (fake values):
# {"keys":[{"id":"key_demo_01","usage":7.12,"usage_scope":"key"}]}

Ví dụ phản hồi

Thành công. Key thông thường có usage_scope: key; Management Key của tổ chức có usage_scope: organization.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "data": {
    "label": "team-management",
    "limit": null,
    "limit_remaining": 81.58,
    "limit_reset": null,
    "expires_at": null,
    "is_free_tier": false,
    "is_management_key": true,
    "is_provisioning_key": true,
    "usage": 18.42,
    "usage_daily": 2.14,
    "usage_weekly": 8.73,
    "usage_monthly": 18.42,
    "requests": 73,
    "requests_daily": 9,
    "requests_weekly": 31,
    "requests_monthly": 73,
    "usage_scope": "organization",
    "rate_limit": {
      "requests": 200,
      "interval": "1m",
      "note": "Paid-tier rate limit."
    }
  }
}