Buat BYOK key

Membuat BYOK upstream key untuk organisasi dan langsung menyinkronkan katalog model. apiKey upstream hanya muncul sebagai teks polos dalam permintaan ini — dienkripsi saat disimpan dan setelahnya hanya dikembalikan tersamar (keyMask). Jika berhasil menjawab 201 dengan objek kunci dan hasil sinkronisasi (sync).

POST/api/v1/management/byok-keys

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

Body

namewajib

string

Nama tampilan kunci.

1-200 chars

baseUrlwajib

string

Base URL API penyedia upstream. Alamat privat/lokal ditolak (400).

1-2000 chars, public HTTPS endpoint

apiKeywajib

string

API key penyedia upstream dalam teks polos. Hanya muncul di permintaan ini; dienkripsi saat disimpan, setelahnya hanya keyMask.

1-2000 chars

protocol

string

Protokol antarmuka API upstream; default openai.

openaianthropic

Example: "openai"

fallbackMode

string

Perilaku saat upstream gagal: seamless (default) kembali ke routing platform; strict tidak fallback dan mengembalikan error.

seamlessstrict

Example: "seamless"

disabledCanonicalIds

string[]

Daftar model (canonical id) yang dinonaktifkan saat pembuatan; setelah sinkronisasi model ini tidak dirutekan lewat kunci ini.

≤2000 items

scopedApiKeyIds

string[]

Membatasi BYOK ini hanya untuk API key platform tertentu (berdasarkan id). Kosong/dihilangkan = berlaku semua kunci organisasi. Menyertakan id yang bukan milik Anda ditolak (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"
  }'

Contoh respons

Dibuat. key adalah objek kunci (hanya keyMask); sync melaporkan hasil sinkronisasi katalog: matched (model yang terpetakan ke katalog platform), unmatched (id model upstream yang tidak ada di katalog), stale (perlukah sinkronisasi ulang nanti).

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