Chuyển đến nội dung chính

Tổng Quan

Dùng endpoint này để cập nhật tên, giới hạn sử dụng, model được phép, thời hạn hết hạn hoặc trạng thái của một API key người dùng hiện có.

Thân Yêu Cầu

Phải cung cấp ít nhất một trường.
TrườngKiểuMặc định / Giới hạnGhi chú
statusenum-active, inactive, revoked
namestringđộ dài 1-50Tên hiển thị đã cập nhật
limitAmountnumber | nulltối thiểu 0, input tối đa 1000000null = không giới hạn, 0 = quota bằng 0. Giá trị dương được chuẩn hoá thành trần lưu trữ không vượt quá tương đương 100000 USD
limitCurrencyenumdefault USDChỉ hỗ trợ USD. Gửi CNY sẽ trả về 400 currency_retired.
modelsstring[]-Danh sách cho phép model đã cập nhật
expiresAtstring | nulldatetime RFC3339null sẽ xoá thời hạn hết hạn

Ghi Chú

  • Hard delete không được hỗ trợ trong Management API v1.
  • revoked là trạng thái kết thúc đối với thao tác vận hành thông thường; hãy tạo key mới thay vì mong đợi có luồng khôi phục sau này.

Ví Dụ

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
  }'

Yêu Cầu / Phản Hồi

Sử dụng bảng OpenAPI tương tác ở trên để xem schema và các trường response chính xác.

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.