API 密钥

获取当前 API 密钥信息

返回 Authorization 标头中密钥的状态、限额、剩余额度、重置周期、过期时间、密钥类型、成功请求的花费与次数，以及速率等级。普通密钥返回该密钥自己的数据，usage_scope 为 key；组织 Management Key 返回整个组织的数据，usage_scope 为 organization，合计与组织仪表板相同。日、周、月边界均按 UTC 计算：每天 UTC 00:00、每周一 UTC 00:00、每月 1 日 UTC 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."
    }
  }
}