Получить текущую информацию о ключе API

Возвращает статус самого ключа, взятый из заголовка авторизации: его лимит расходов и оставшаяся сумма, срок действия, тип ключа, совокупные/ежедневные/еженедельные/месячные расходы и количество запросов, а также ограничение скорости. limit/limit_remaining не равны нулю только в том случае, если для этого конкретного ключа настроен собственный лимит расходов на ключ; в противном случае вместо этого возвращается баланс кошелька аккаунта.

GET/api/v1/key

Авторизация

Authorizationобязательно

string · header

Ключ API как Bearer-токен в заголовке Authorization.

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 — это два имени для одного и того же базового флага (совпадающие как с собственным именем API, так и с более распространенным отраслевым термином), а не две независимые возможности.

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