Saltar para o conteúdo principal

​
Visão geral

Use este endpoint para atualizar nome, limite de uso, modelos permitidos, data de expiração ou status de uma API Key existente.

​
Corpo da requisição

A requisição PATCH deve incluir pelo menos um campo.
CampoTipoPadrões / limitesDescrição
statusenum-active, inactive, revoked
namestringtamanho 1-50Nome de exibição atualizado
limitAmountnumber | nullmínimo 0, máximo de entrada 1000000null = ilimitado, 0 = quota zero. Valores positivos são normalizados para um teto armazenado que não pode exceder 100000 USD equivalente.
limitCurrencyenumdefault USDApenas USD. Enviar CNY retorna 400 currency_retired.
modelsstring[]-Allowlist atualizada de modelos lógicos
expiresAtstring | nulldatetime RFC3339null remove a expiração

​
Observações

  • A exclusão definitiva não é suportada intencionalmente na Management API v1.
  • revoked costuma ser tratado como estado terminal; se você precisar usar outra chave, normalmente é melhor criar uma nova.

​
Exemplo

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

​
Requisição / Resposta

Consulte o painel interativo de OpenAPI acima para ver o schema exato e os campos da resposta.

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