Ключи управления

Получить API-ключ

Возвращает один API-ключ в пределах видимости вызывающей стороны. Для организационного Management Key ID должен относиться к его организации; личные ключи владельца и ключи других организаций в обоих случаях дают 404, не раскрывая факт существования. Формат ответа: { data: <key>, key: <key> }, оба поля содержат один и тот же объект. Объект включает limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly и usage_scope: key. Значения использования совпадают с GET /v1/key при вызове этим ключом. limit_remaining — это лимит минус расход ключа за период сброса, а без собственного лимита — баланс аккаунта или организации. Секрет ключа не возвращается.

GET/v1/keys/:id

Авторизация

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

string · header

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

Параметры пути

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

string

Идентификатор API-ключа для получения.

GET /v1/keys/:id

1
2
curl https://api.bazaarlink.ai/v1/keys/key_demo_01 \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

Примеры ответов

Успешно. data и key содержат один и тот же объект ключа, его usage_scope всегда равен key.

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}