Gerenciamento

API de gerenciamento

Gerencie saldo da organização, API Keys e uso e faturamento por chave usando um token de gerenciamento.

Visão geral

A API de gerenciamento permite consultar os totais de saldo da organização, gerenciar as API Keys da organização e consultar uso e faturamento por chave sem usar uma API Key padrão de inferência.

Crie e rotacione o token de gerenciamento em Dashboard → API → Management Tokens.

Authorization: Bearer mt-your-management-token

Tokens de gerenciamento são diferentes de API Keys de inferência. Use mt-... para /v1/management/* e sk-... para endpoints de inferência como /v1/responses.

Endpoints disponíveis

EndpointMétodoDescrição
/v1/management/balanceGETRetorna os totais atuais de saldo da organização
/v1/management/api-keysGETLista as API Keys de usuário da organização atual
/v1/management/api-keysPOSTCria uma nova API Key de usuário
/v1/management/api-keys/{keyId}PATCHAtualiza nome, limite de uso, modelos permitidos, expiração ou status
/v1/management/api-keys/{keyId}/usageGETRetorna o detalhamento paginado de uso para uma chave específica
/v1/management/api-keys/{keyId}/billingGETRetorna o detalhamento agregado de faturamento para uma chave específica

Contrato de filtros de uso

GET /v1/management/api-keys/{keyId}/usage aceita os seguintes parâmetros de query.

ParâmetroTipoPadrões / limitesDescrição
pageintegerpadrão 1, mínimo 1Número da página começando em 1
limitintegerpadrão 50, mínimo 1, máximo 100Tamanho da página
modelstringcomprimento máximo 100Nome do modelo solicitado
modelVendorstringcomprimento máximo 100Fornecedor público do modelo
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d, realtime
startDatestring-Limite inferior inclusivo; aceita RFC3339 com fuso horário ou YYYY-MM-DD
endDatestring-Limite superior inclusivo; aceita RFC3339 com fuso horário ou YYYY-MM-DD

Se startDate e endDate forem enviados juntos, startDate deve ser anterior ou igual a endDate.

Contrato do corpo da API Key

POST /v1/management/api-keys

CampoTipoPadrões / limitesDescrição
namestringopcional, padrão Default Key, tamanho 1-50Nome de exibição; o servidor remove espaços no início e no fim
limitAmountnumber | string | null0–100000 USDnull significa sem limite; 0 impede gastos. Strings decimais aceitam até 6 casas decimais. Na criação da chave, omitir este campo significa sem limite.
limitCurrencyenumpadrão USDApenas USD. Enviar CNY retorna 400 currency_retired.
modelsstring[]padrão []Allowlist opcional de modelos lógicos
deliveryPolicystring | nullauto, verified, official, nullnull herda a política de entrega do espaço de trabalho.
expiresAtstring | nulldatetime RFC3339null significa sem expiração

PATCH /v1/management/api-keys/{keyId}

CampoTipoPadrões / limitesDescrição
statusenum-active, inactive, revoked
namestringtamanho 1-50Nome de exibição atualizado
limitAmountnumber | string | null0–100000 USDnull significa sem limite; 0 impede gastos. Strings decimais aceitam até 6 casas decimais.
limitCurrencyenumpadrão USDApenas USD. Enviar CNY retorna 400 currency_retired. Se informado, limitAmount também é obrigatório.
modelsstring[]-Allowlist atualizada de modelos lógicos
deliveryPolicystring | nullauto, verified, official, nullnull herda a política de entrega do espaço de trabalho.
expiresAtstring | nulldatetime RFC3339null remove a expiração

A requisição PATCH deve incluir pelo menos um campo.

Campos monetários

  • Os campos monetários de requisição e resposta da API de gerenciamento aceitam apenas USD.
  • limitCurrency usa USD por padrão; enviar CNY retorna 400 currency_retired.

Semântica de reporting

  • model se refere ao modelo público solicitado por quem faz a chamada.
  • modelVendor se refere ao fornecedor público do modelo, e não à rota física oculta.
  • scene é a cena pública da solicitação derivada do endpoint ou do tipo de tarefa.

As respostas expõem apenas campos públicos de faturamento e reporting. Os detalhes internos de roteamento e a metadata física do provedor permanecem ocultos.

  • Itens de /usage podem incluir billing_transaction_id assim que a requisição subjacente atingir o estado de liquidação concluída. Use request_id + billing_transaction_id para reconciliação por requisição.

Nota sobre a paginação de faturamento

/usage é paginado. /billing atualmente é um endpoint agregado e não retorna metadata de paginação no estilo page / limit. Se você precisar de registros detalhados linha a linha, use /usage.

Exemplo rápido

Comece consultando o saldo da organização com o token de gerenciamento atual.

Requisição

cURL
curl -X GET "https://api.tokenlab.sh/v1/management/balance" \
  -H "Authorization: Bearer mt-your-management-token"

Em seguida, liste as API Keys disponíveis para esse mesmo token de gerenciamento.

Requisição

cURL
curl "https://api.tokenlab.sh/v1/management/api-keys" \
  -H "Authorization: Bearer mt-your-management-token"

Resposta

Response (200)
{
  "object": "list",
  "data": [
    {
      "id": "key_abc123def456",
      "name": "Backend Worker",
      "key_prefix": "sk-abc123...",
      "status": "active",
      "limit_amount": 500.0,
      "limit_amount_decimal": "500",
      "used_amount": 148.25,
      "used_amount_decimal": "148.25",
      "models": [
        "gpt-4o-mini",
        "claude-3-7-sonnet"
      ],
      "expires_at": "2026-04-30T00:00:00.000Z",
      "last_used_at": "2026-03-27T08:12:45.000Z",
      "created_at": "2026-03-01T10:00:00.000Z",
      "delivery_policy": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1
  }
}

Próximos passos

Nesta página