BYOK-Schlüssel erstellen

Erstellt einen BYOK-Upstream-Schlüssel für die Organisation und synchronisiert sofort den Modellkatalog. Der Upstream-apiKey erscheint nur in dieser Anfrage im Klartext — er wird verschlüsselt gespeichert und danach nur maskiert (keyMask) zurückgegeben. Bei Erfolg antwortet 201 mit dem Schlüsselobjekt und dem Sync-Ergebnis (sync).

POST/api/v1/management/byok-keys

Autorisierung

Authorizationerforderlich

string · header

API-Schlüssel als Bearer-Token im Authorization-Header.

Body

nameerforderlich

string

Anzeigename für den Schlüssel.

1-200 chars

baseUrlerforderlich

string

Die API-Base-URL des Upstream-Providers. Private/lokale Adressen werden abgelehnt (400).

1-2000 chars, public HTTPS endpoint

apiKeyerforderlich

string

Der API-Schlüssel des Upstream-Providers im Klartext. Erscheint nur in dieser Anfrage; verschlüsselt gespeichert, danach wird nur keyMask zurückgegeben.

1-2000 chars

protocol

string

Das API-Schnittstellenprotokoll des Upstreams; Standard openai.

openaianthropic

Example: "openai"

fallbackMode

string

Verhalten bei Upstream-Fehler: seamless (Standard) fällt auf Plattform-Routing zurück; strict fällt nicht zurück und gibt den Fehler zurück.

seamlessstrict

Example: "seamless"

disabledCanonicalIds

string[]

Bei der Erstellung zu deaktivierende Modelle (canonical ids); nach dem Sync werden diese Modelle nicht über diesen Schlüssel geroutet.

≤2000 items

scopedApiKeyIds

string[]

Beschränkt diesen BYOK-Schlüssel auf bestimmte Plattform-API-Schlüssel (per Key-Id). Leer/weggelassen = gilt für alle Schlüssel der Org. Fremde Key-Ids werden abgelehnt (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"
  }'

Antwortbeispiele

Erstellt. key ist das Schlüsselobjekt (nur keyMask); sync meldet das Katalog-Sync-Ergebnis: matched (dem Plattformkatalog zugeordnete Modelle), unmatched (Upstream-Modell-Ids ohne Katalogeintrag), stale (ob später ein Re-Sync nötig ist).

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