管理金鑰

取得單一 API 金鑰

取得呼叫者可見範圍內的一把 API 金鑰。使用組織 Management Key 時，id 必須屬於該金鑰自己的組織；擁有者的個人金鑰或其他組織的金鑰都會以 404 回應，不會洩漏是否存在。回應格式是 { data: <key>, key: <key> }，兩個欄位內容相同。<key> 包含 limit、limit_remaining、limit_reset、usage、usage_daily/weekly/monthly、requests、requests_daily/weekly/monthly 與 usage_scope: key；這些用量數字與使用該金鑰呼叫 GET /v1/key 的結果一致。limit_remaining 是限額扣除該金鑰重設週期花費後的數字，沒有個別限額時則是該金鑰所使用的帳戶或組織餘額。回應不包含祕密值。

GET/v1/keys/:id

驗證

Authorization必填

string · header

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

路徑參數

id必填

string

要取得的 API 金鑰 ID。

GET /v1/keys/:id

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

回應範例

成功。data 與 key 會以相同的金鑰物件回傳，且 usage_scope 永遠是 key。

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}