Ключи API

Получить сведения о текущем API-ключе

Возвращает состояние ключа из заголовка Authorization: лимит, остаток, период сброса, срок действия, тип ключа, расходы и число успешных запросов, а также уровень ограничения скорости. Обычный ключ показывает только свои значения и usage_scope: key; организационный Management Key показывает значения всей организации с usage_scope: organization, используя тот же итог, что и панель организации. Границы дня, недели и месяца считаются по UTC: 00:00 UTC, понедельник 00:00 UTC и первый день месяца в 00:00 UTC. Если у организационного ключа нет собственного лимита, limit_remaining, is_free_tier и уровень скорости используют баланс организации. Баланс аккаунта можно получить через GET /v1/credits. В примере ниже Management Key сначала получает общий итог организации, а затем использование каждого ключа. При наличии собственного лимита limit_remaining равен лимиту минус расход ключа за дневной, недельный или месячный период сброса; без собственного лимита используется баланс аккаунта, а для организационного ключа — баланс организации.

GET/v1/key

Авторизация

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

string · header

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

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