API 金鑰

取得目前 API 金鑰資訊

回傳 Authorization 標頭中金鑰的狀態、限額、剩餘額度、重設週期、到期日、金鑰類型、成功請求的花費與次數，以及速率等級。一般金鑰回報這把金鑰自己的數字，usage_scope 為 key；組織 Management Key 則回報整個組織的數字，usage_scope 為 organization，且與組織儀表板相同。所有日、週、月邊界都以 UTC 計算：日從 00:00 開始、週從星期一 00:00 開始、月從每月 1 日 00:00 開始。若組織金鑰沒有個別限額，limit_remaining、is_free_tier 與速率等級依組織餘額計算。帳戶餘額請使用 GET /v1/credits。下方範例用管理金鑰先查看組織總額，再查看每把金鑰的用量。有個別限額時，limit_remaining 是限額扣除該金鑰在日、週或月重設週期內花費後的餘額；沒有個別限額時，依該金鑰使用的帳戶餘額計算，組織金鑰則使用組織餘額。

GET/v1/key

驗證

Authorization必填

string · header

在 Authorization 標頭以 Bearer token 傳入 API 金鑰。

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"}]}

回應範例

成功。一般金鑰的 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."
    }
  }
}