跳轉到主要內容

概覽

這個 endpoint 會在目前管理令牌所屬的組織下,建立一把新的 type=user API Key。

請求主體

欄位型別預設值 / 限制說明
namestring必填,預設 Default Key,長度 1-50顯示名稱,伺服器端會先去除前後空白
limitAmountnumber | null最小 0,輸入上限 1000000null 或省略 = 不限額,0 = 零額度,正數會被規範化為一個儲存上限,且不能超過 100000 USD 等值
limitCurrency列舉預設 USD僅限 USD。傳送 CNY 會回傳 400 currency_retired
modelsstring[]預設 []可選的模型白名單
expiresAtstring | nullRFC3339 datetimenull 表示沒有到期時間

說明

  • 回應中的完整 API Key 只會顯示一次。
  • models: [] 表示這把 Key 除了組織層政策外,沒有額外的模型限制。
  • limitAmount: 0 會建立一把有效、但暫時無法消耗額度的 Key,之後可再更新。

範例

curl -X POST "https://api.tokenlab.sh/v1/management/api-keys" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Backend Worker",
    "limitAmount": 500,
    "models": ["veo3.1", "kling-3.0-video"],
    "expiresAt": "2026-12-31T23:59:59Z"
  }'

請求 / 回應

精確 schema 與回應欄位,請使用上方的互動式 OpenAPI 面板。

Response example

{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key": "sk-live-redacted",
  "key_prefix": "sk-live...",
  "status": "active",
  "limit_amount": 500,
  "limit_amount_decimal": "500",
  "used_amount": 0,
  "used_amount_decimal": "0",
  "models": [
    "veo3.1",
    "kling-3.0-video"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": null,
  "created_at": "2026-07-08T03:00:00.000Z"
}

Important fields

key
string
Full secret API key value. It is returned only once on creation.
id
string
API key identifier used in follow-up Management API calls.
name
string
Display name for the API key.
key_prefix
string
Non-secret key prefix for display and support.
status
string
One of active, inactive, or revoked.
limit_amount
number | null
Spending cap in USD as a JSON number for display. null means unlimited.
limit_amount_decimal
string | null
Exact spending cap in USD as a decimal string. null means unlimited.
used_amount
number
Accumulated usage in USD as a JSON number for display.
used_amount_decimal
string
Exact accumulated usage in USD as a decimal string.
models
string[]
Per-key model allowlist. Empty array means no additional key-level model restriction.
expires_at
string | null
ISO timestamp when the key expires, or null for no expiry.
last_used_at
string | null
ISO timestamp for the most recent use, or null when unused.
created_at
string
ISO creation timestamp.