管理密钥

获取单个 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
  }
}