Management Key

API キーを取得

呼び出し元の可視範囲にある 1 つの 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 トークンとして 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
  }
}