Gerenciamento

Atualizar chave de API

Atualize uma chave de API no Workspace atual.

PATCHhttps://api.tokenlab.sh/v1/management/api-keys/{keyId}

Visão geral

Use este endpoint para atualizar o nome, limite de uso, modelos permitidos, expiração ou status de uma chave de API de usuário existente.

Corpo da requisição

Pelo menos um campo deve ser fornecido.

CampoTipoPadrão / LimitesObservações
statusenum-active, inactive, revoked
namestringcomprimento 1-50Nome de exibição atualizado
limitAmountnumber | string | null0–100000 USDnull significa ilimitado; 0 impede gastos. Strings decimais suportam até 6 casas decimais.
limitCurrencyenumpadrão USDApenas USD. O envio de CNY retorna 400 currency_retired. Quando definido, limitAmount é obrigatório.
modelsstring[]-Lista de permissões de modelos atualizada
deliveryPolicystring | nullauto, verified, official, nullnull herda a política de entrega do Workspace.
expiresAtstring | nulldata e hora RFC3339null remove a expiração

Observações

  • Campos monetários são apenas em USD. Entradas em CNY foram descontinuadas e retornam 400 currency_retired.

  • A Management API não oferece exclusão. Use inactive para uma pausa temporária e revoked para desativar uma chave permanentemente.

  • Substitua uma chave revogada por uma nova. Definir uma chave revogada como active retorna 409 api_key_revoked.

  • suspended pode aparecer nas respostas, mas você não pode enviá-lo.

Exemplo

Requisição

cURL
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

Esta página fornece o schema OpenAPI e exemplos de requisição copiáveis. Envie requisições de gerenciamento a partir do seu terminal ou cliente com um Management Token; o envio direto não está disponível nesta página.

Exemplo de resposta

Resposta

200 OK
{
  "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.6-luna",
    "claude-sonnet-4-6"
  ],
  "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",
  "delivery_policy": null
}

Campos importantes

idstring
Identificador da chave de API usado em chamadas de acompanhamento da Management API.
namestring
Nome de exibição para a chave de API.
key_prefixstring
Prefixo não secreto da chave para exibição e suporte.
statusstring
Um entre active, inactive, suspended ou revoked.
limit_amountnumber | null
Limite de gastos em USD como um número JSON para exibição. null significa ilimitado.
limit_amount_decimalstring | null
Limite de gastos exato em USD como uma string decimal. null significa ilimitado.
used_amountnumber
Uso acumulado em USD como um número JSON para exibição.
used_amount_decimalstring
Uso acumulado exato em USD como uma string decimal.
modelsstring[]
Lista de permissões de modelos por chave. Um array vazio significa nenhuma restrição adicional de modelo no nível da chave.
delivery_policystring | null
auto, verified, official, null. null herda a política de entrega do Workspace.
expires_atstring | null
Timestamp ISO de quando a chave expira, ou null para nenhuma expiração.
last_used_atstring | null
Timestamp ISO do uso mais recente, ou null quando não utilizada.
created_atstring
Timestamp ISO de criação.

Autorização

ManagementTokenAuth
AuthorizationBearer <token>

Autenticação por token de gerenciamento. Crie ou gerencie Tokens de Gerenciamento em Dashboard > API > Management Tokens.

Local: header

Parâmetros de caminho

keyId*string

Corpo da requisição

application/json

Pelo menos um campo deve ser fornecido.

Propriedades1 <= properties

Resposta

application/json

application/json

application/json

application/json

application/json

application/json