Passer au contenu principal

Vue d’ensemble

Utilisez cet endpoint pour mettre à jour le nom, la limite d’usage, les modèles autorisés, l’expiration ou le statut d’une API Key utilisateur existante.

Corps de la requête

Au moins un champ doit être fourni dans la requête PATCH.
ChampTypeValeurs par défaut / limitesDescription
statusenum-active, inactive, revoked
namestringlongueur 1-50Nom affiché mis à jour
limitAmountnumber | nullmin. 0, entrée max. 1000000null = illimité, 0 = quota nul. Les valeurs positives sont normalisées vers un plafond stocké qui ne peut pas dépasser l’équivalent de 100000 USD.
limitCurrencyenumvaleur par défaut USDUSD uniquement. L’envoi de CNY renvoie 400 currency_retired.
modelsstring[]-Liste d’autorisation des modèles logiques mise à jour
expiresAtstring | nulldatetime RFC3339null efface la date d’expiration

Notes

  • Les champs monétaires sont réservés au USD. Les entrées CNY sont obsolètes et renvoient 400 currency_retired.
  • Le hard delete n’est volontairement pas pris en charge dans Management API v1.
  • revoked est terminal pour l’usage opérationnel courant ; créez une nouvelle clé au lieu d’attendre un futur flux de réactivation.

Exemple

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

Requête / Réponse

Utilisez le panneau OpenAPI interactif ci-dessus pour obtenir le schéma exact et les champs de réponse.

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.