BYOK कुंजी बनाएँ

संगठन के लिए एक BYOK अपस्ट्रीम कुंजी बनाता है और तुरंत मॉडल कैटलॉग सिंक करता है। अपस्ट्रीम apiKey केवल इसी अनुरोध में सादे रूप में दिखती है — संग्रहण पर एन्क्रिप्ट होती है और बाद में केवल छिपे रूप (keyMask) में लौटती है। सफल होने पर 201 के साथ कुंजी ऑब्जेक्ट और सिंक परिणाम (sync) मिलता है।

POST/api/v1/management/byok-keys

प्राधिकरण

Authorizationआवश्यक

string · header

Authorization हेडर में bearer token के रूप में 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
  }
}