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 で取得してください。下の例では Management Key で組織全体の合計を確認してから、各キーの使用量を確認します。個別上限がある場合、limit_remaining は日次・週次・月次のリセット期間におけるこのキーの支出を上限から引いた値です。個別上限がない場合はキーが使うアカウント残高を使い、組織キーでは組織残高を使います。

GET/v1/key

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして 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."
    }
  }
}