BYOKキーを作成

組織の BYOK アップストリームキーを作成し、直ちにモデルカタログを同期します。アップストリームの apiKey が平文で現れるのはこのリクエストのみで、保存時に暗号化され、以後はマスク形式(keyMask)でのみ返されます。成功時は 201 でキーオブジェクトと同期結果(sync)を返します。

POST/api/v1/management/byok-keys

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして API キーを渡します。

Body

name必須

string

キーの表示名。

1-200 chars

baseUrl必須

string

アップストリームプロバイダーの API base URL。プライベート/ローカルアドレスは拒否されます(400)。

1-2000 chars, public HTTPS endpoint

apiKey必須

string

アップストリームプロバイダーの API キー(平文)。このリクエストのみに現れ、暗号化保存され、以後は keyMask のみ返されます。

1-2000 chars

protocol

string

アップストリームの API 介面プロトコル。デフォルトは openai。

openaianthropic

Example: "openai"

fallbackMode

string

アップストリーム失敗時の挙動:seamless(デフォルト)=プラットフォームルーティングへ回退;strict=回退せずエラーを返す。

seamlessstrict

Example: "seamless"

disabledCanonicalIds

string[]

作成時に無効化するモデル(canonical id)のリスト。同期後、これらのモデルはこのキー経由でルーティングされません。

≤2000 items

scopedApiKeyIds

string[]

この BYOK を適用するプラットフォーム API キー(キー id)を限定します。空/省略=組織の全キーに適用。所有していないキー id を含むと拒否されます(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 はモデルカタログ同期の結果を報告します:matched(プラットフォームカタログに対応したモデル数)、unmatched(アップストリームにあるがカタログにないモデル id)、stale(後で再同期が必要か)。

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