跳转到主要内容

​
概览

该接口用于更新已有用户 API Key 的名称、额度、模型白名单、过期时间或状态。

​
请求体

PATCH 请求至少需要提供一个字段。
字段类型默认值 / 限制说明
statusenum-active, inactive, revoked
namestring长度 1-50更新后的展示名称
limitAmountnumber | null最小 0，输入上限 1000000null = 不限额，0 = 零额度，正数会被规范化为一个存储上限，且不能超过 100000 USD 等值
limitCurrencyenum默认 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.