管理金鑰

建立 API 金鑰

建立一把新的標準 API 金鑰(或另一把管理金鑰)。管理端點——呼叫時若用 Bearer token 認證,該金鑰必須是 Management API Key,一般的 sk-bl- 金鑰打不了這支;也可用登入後的 session cookie。回應裡的 key 欄位是唯一一次可見金鑰明文的機會,之後系統只存雜湊,再也拿不回來。

POST/api/v1/keys

驗證

Authorization必填

string · header

在 Authorization 標頭以 Bearer token 傳入 API 金鑰。

Body

name必填

string

金鑰的顯示名稱,會自動去除頭尾空白;去除後不可為空字串。

≤200 chars, trimmed non-empty

keyType

string

金鑰種類,預設 standard;任何非 "management" 的值都會被當成 standard 處理。

standardmanagement

Example: "standard"

limit

number | null

支出上限(美元),存為 spendLimitUsd。null 或省略表示無上限。設定時必須同時提供 limit_reset。GET /v1/key 會把這個值回報在 limit 欄位。

0–1,000,000

limit_reset

string | null

支出上限的重置週期,存為 spendLimitPeriod。接受 OR 相容別名(daily/weekly/monthly)或內部原名(day/week/month),兩種寫法皆可、效果相同。

dailyweeklymonthlydayweekmonth

Example: "monthly"

expires_at

string | null

金鑰的到期時間,ISO 日期字串,必須是未來時間。null 或省略表示永不過期。

Example: "2027-01-01T00:00:00Z"

organizationId

string | null

把金鑰綁定到指定組織,而非個人帳號。呼叫者必須通過該組織/team/成員範圍的授權檢查,否則回 400。

teamId

string | null

把金鑰進一步縮限到組織裡的特定 team。搭配 organizationId 使用。

orgMemberId

string | null

把金鑰進一步縮限到組織裡的特定成員。搭配 organizationId 使用。

POST /api/v1/keys

1
2
3
4
curl https://bazaarlink.ai/api/v1/keys \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "production", "limit": 50, "limit_reset": "monthly"}'

回應範例

建立成功。key 欄位是完整明文,只在這次回應出現一次,請立刻儲存——之後包括呼叫者自己都無法再取得。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "id": "key_abc123",
  "name": "production",
  "key": "sk-bl-AbCdEfGh...",
  "keyType": "standard",
  "prefix": "sk-bl-",
  "enabled": true,
  "spendLimitUsd": 50,
  "spendLimitPeriod": "month",
  "expiresAt": null,
  "createdAt": "2026-07-27T00:00:00.000Z",
  "organizationId": null,
  "teamId": null,
  "orgMemberId": null
}