跳轉到主要內容

​
概覽

這個 endpoint 可更新既有 API Key 的名稱、額度、模型白名單、過期時間或狀態。

​
請求主體

PATCH 請求至少需要提供一個欄位。
欄位型別預設值 / 限制說明
statusenum-active, inactive, revoked
namestring長度 1-50更新後的顯示名稱
limitAmountnumber | null最小 0，輸入上限 1000000null = 不限額，0 = 零額度，正數會被規範化為一個儲存上限，且不能超過 100000 USD 等值
limitCurrency列舉預設 USD僅限 USD。傳送 CNY 會回傳 400 currency_retired。
modelsstring[]-更新後的模型白名單
expiresAtstring | nullRFC3339 datetimenull 表示移除過期時間

​
說明

  • Management API v1 故意不支援硬刪除。
  • revoked 通常視為終態；若需要重新使用，通常建議直接建立一把新的 Key。

​
範例

curl -X PATCH "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "limitAmount": 0
  }'

​
請求 / 回應

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

​
Response example

{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key_prefix": "sk-live...",
  "status": "inactive",
  "limit_amount": 0,
  "limit_amount_decimal": "0",
  "used_amount": 148.25,
  "used_amount_decimal": "148.25",
  "models": [
    "gpt-5-mini",
    "claude-3-7-sonnet"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": "2026-07-08T03:12:45.000Z",
  "created_at": "2026-07-01T10:00:00.000Z"
}

​
Important fields

​
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.