現在の API キー情報を取得

Authorization ヘッダーに含まれるこのキー自体のステータスを返します:支出上限と残量、有効期限、キー種別、累計/日次/週次/月次の支出とリクエスト数、レート制限。limit/limit_remaining は、このキー固有の支出上限(spendLimitUsd)が設定されている場合のみ null 以外の値になります。それ以外はアカウントの残高が返されます。

GET/api/v1/key

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして API キーを渡します。

GET /api/v1/key

1
2
curl https://bazaarlink.ai/api/v1/key \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY"

レスポンス例

成功。is_management_key と is_provisioning_key は同一の内部フラグの 2 つの名前であり(このAPI独自の命名と、より一般的な業界用語の両方に対応)、2 つの独立した機能ではありません。

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
{
  "data": {
    "label": "default",
    "limit": 50,
    "limit_remaining": 42.5,
    "limit_reset": "month",
    "expires_at": null,
    "is_free_tier": false,
    "is_management_key": false,
    "is_provisioning_key": false,
    "usage": 128.4,
    "usage_daily": 1.2,
    "usage_weekly": 8.6,
    "usage_monthly": 27.9,
    "requests": 940,
    "requests_daily": 12,
    "requests_weekly": 88,
    "requests_monthly": 340,
    "rate_limit": {
      "requests": 200,
      "interval": "1m",
      "note": "Paid-tier rate limit."
    }
  }
}