API Key

ดูข้อมูล API key ปัจจุบัน

คืนสถานะของ key ใน header Authorization ได้แก่ ขีดจำกัด ยอดคงเหลือ ช่วงรีเซ็ต วันหมดอายุ ประเภท key ยอดใช้จ่ายและจำนวนคำขอที่สำเร็จ รวมถึงระดับ rate limit โดย key ทั่วไปจะแสดงข้อมูลของ key นั้นเองและใช้ usage_scope: key ส่วน Management Key ขององค์กรจะแสดงข้อมูลทั้งองค์กรและใช้ usage_scope: organization โดยยอดรวมตรงกับแดชบอร์ดขององค์กร ขอบเขตวัน สัปดาห์ และเดือนยึด UTC: 00:00 UTC, วันจันทร์ 00:00 UTC และวันที่ 1 ของเดือนเวลา 00:00 UTC หาก key ขององค์กรไม่มีขีดจำกัดเฉพาะ key ค่า limit_remaining, is_free_tier และระดับ rate จะอิงยอดคงเหลือขององค์กร ใช้ GET /v1/credits เพื่อดูยอดคงเหลือของบัญชี ตัวอย่างด้านล่างใช้ management key เพื่อดูยอดรวมองค์กร แล้วดูการใช้งานของแต่ละ key หากมีขีดจำกัดเฉพาะ key ค่า limit_remaining คือขีดจำกัดลบยอดใช้จ่ายของ key ในช่วงรีเซ็ตรายวัน รายสัปดาห์ หรือรายเดือน หากไม่มีขีดจำกัดเฉพาะ key จะใช้ยอดคงเหลือของบัญชีที่ key นั้นใช้ และ key ขององค์กรจะใช้ยอดคงเหลือขององค์กร

GET/v1/key

การอนุญาต

Authorizationจำเป็น

string · header

API key เป็น bearer token ใน 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"}]}

ตัวอย่างการตอบกลับ

สำเร็จ key ทั่วไปมี usage_scope: key ส่วน Management Key ขององค์กรมี 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."
    }
  }
}