Создайте ключ BYOK.

Создает восходящий ключ BYOK для организации и немедленно синхронизирует каталог моделей. Восходящий apiKey появляется в открытом тексте только в этом запросе — он зашифрован в состоянии покоя и возвращается только в маске (keyMask). В случае успеха отвечает 201 с ключевым объектом и результатом синхронизации модели (синхронизация).

POST/api/v1/management/byok-keys

Авторизация

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

string · header

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

Тело

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

string

Отображаемое имя ключа.

1-200 chars

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

string

База API вышестоящего провайдера URL. Частные или локальные адреса отклоняются (400).

1-2000 chars, public HTTPS endpoint

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

string

Ключ API вышестоящего провайдера в текстовом виде. Появляется только в этом запросе; зашифровано в состоянии покоя, после этого возвращается только keyMask.

1-2000 chars

protocol

string

Протокол интерфейса API восходящего потока; по умолчанию стоит openai.

openaianthropic

Example: "openai"

fallbackMode

string

Поведение при сбое восходящего потока: бесшовный (по умолчанию) возврат к маршрутизации платформы; strict не отступает и возвращает ошибку.

seamlessstrict

Example: "seamless"

disabledCanonicalIds

string[]

Модели (канонические идентификаторы), которые нужно отключить при создании; после синхронизации эти модели не будут маршрутизироваться через этот ключ.

≤2000 items

scopedApiKeyIds

string[]

Ограничивает этот ключ BYOK ключами API конкретной платформы (по идентификатору ключа). Пусто/пропущено = применяется ко всем ключам организации. Включение идентификатора ключа, которым вы не владеете, отклонено (400).

≤200 items; must be your own keys

POST /api/v1/management/byok-keys

1
2
3
4
5
6
7
8
9
10
curl https://bazaarlink.ai/api/v1/management/byok-keys \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "team-upstream",
    "baseUrl": "https://api.example-upstream.com/v1",
    "apiKey": "'$UPSTREAM_API_KEY'",
    "protocol": "openai",
    "fallbackMode": "seamless"
  }'

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

Созданный. key — ключевой объект (только keyMask); sync сообщает о синхронизации каталога моделей: соответствует (модели сопоставлены с каталогом платформы), не соответствует (идентификаторы исходных моделей отсутствуют в каталоге платформы), устаревшие (необходима ли последующая повторная синхронизация).

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
{
  "key": {
    "id": "byok_abc123",
    "ownerType": "org",
    "userId": null,
    "organizationId": "org_abc123",
    "name": "team-upstream",
    "baseUrl": "https://api.example-upstream.com/v1",
    "keyMask": "sk-abc…wxyz",
    "protocol": "openai",
    "enabled": true,
    "fallbackMode": "seamless",
    "modelsStale": false,
    "lastVerifiedAt": "2026-07-29T00:00:00.000Z",
    "lastErrorAt": null,
    "lastErrorCode": null,
    "errorCount1h": 0,
    "createdAt": "2026-07-29T00:00:00.000Z",
    "updatedAt": "2026-07-29T00:00:00.000Z",
    "models": [
      {
        "canonicalId": "openai/gpt-4o",
        "upstreamModelId": "gpt-4o",
        "enabled": true
      }
    ],
    "scopedApiKeyIds": []
  },
  "sync": {
    "matched": 12,
    "unmatched": [
      "internal-model-x"
    ],
    "stale": false
  }
}