API Keys

Get current API key info

Returns the Authorization key's status, limits, remaining amount, reset period, expiry, key type, successful-request spend and counts, and rate tier. An ordinary key reports its own figures with usage_scope: key; an organization Management Key reports the whole organization's figures with usage_scope: organization, using the same total as the organization dashboard. Day, week, and month boundaries are UTC: 00:00 UTC, Monday 00:00 UTC, and the first day of the month at 00:00 UTC. When a per-key limit exists, limit_remaining is the limit minus this key's spend in its day, week, or month reset period; when no per-key limit exists, it falls back to the account balance, or the organization balance for an organization key. is_free_tier and the rate tier also use the organization balance for an organization key without its own limit. Use GET /v1/credits for the account balance. The example below uses a management key to see the organization total and then each key's usage.

GET/v1/key

Authorizations

Authorizationrequired

string · header

API key as bearer token in the Authorization header.

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"}]}

Response examples

Success. An ordinary key has usage_scope: key; an organization Management Key has 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."
    }
  }
}