TokenLab
Obter chave de API
DocumentaçãoReferência da APIIntegrações

Gerenciamento

Obter faturamento da chave API

Retorna detalhamentos agregados de faturamento para uma chave API de usuário.

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

Visão Geral

Este endpoint retorna agregados de faturamento baseados em consumo para a chave API selecionada, incluindo custo total, total de requisições, uso por unidade de faturamento, os detalhamentos by_model, by_logical_model, by_model_vendor e by_scene, além da tendência diária de custo.

Notas

  • Os campos monetários aceitam apenas USD.

  • Recargas, faturas e outros registros financeiros em nível de organização ficam de fora.

Exemplo

Aceita os mesmos filtros de modelo, fornecedor, cena e data que o uso da chave API. Retorna totais sem paginação.

Requisição

cURL
curl -X GET "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456/billing?startDate=2026-07-01&endDate=2026-07-31" \
  -H "Authorization: Bearer mt-your-management-token"

Solicitação / Resposta

Esta página fornece o esquema OpenAPI e exemplos de requisições para copiar. Envie solicitações de gerenciamento pelo terminal ou cliente usando um Management Token; o envio direto não está disponível nesta página.

Exemplo de resposta

Resposta

200 OK
{
  "api_key": {
    "id": "key_abc123def456",
    "name": "Backend Worker",
    "key_prefix": "sk-live...",
    "status": "active",
    "limit_amount": 500,
    "limit_amount_decimal": "500",
    "used_amount": 148.25,
    "used_amount_decimal": "148.25",
    "models": [
      "gpt-5.6-luna",
      "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",
    "delivery_policy": null
  },
  "summary": {
    "total_requests": 1,
    "total_cost": 0.0012,
    "total_cost_decimal": "0.0012",
    "total_prompt_tokens": 1000,
    "total_completion_tokens": 500,
    "total_tokens": 1500,
    "usage_unit_breakdown": [
      {
        "usage_unit": "per_token",
        "usage_quantity": 1500
      }
    ]
  },
  "breakdowns": {
    "by_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_logical_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_model_vendor": [
      {
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012
      }
    ],
    "by_scene": [
      {
        "scene": "chat",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ],
    "daily_cost": [
      {
        "date": "2026-07-08T00:00:00.000Z",
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ]
  }
}

Campos importantes

api_keyobject
Resumo da chave de API com os mesmos campos das respostas de listagem, criação e atualização.
summaryobject
Totais agregados para os filtros selecionados.
breakdownsobject
Detalhamentos agregados para os filtros selecionados.
summary.total_requestsnumber
Total de solicitações.
summary.total_costnumber
Custo total em USD como número JSON para exibição.
summary.total_cost_decimalstring
Custo total exato em USD como string decimal.
summary.total_prompt_tokensnumber
Contagem total de tokens do prompt.
summary.total_completion_tokensnumber
Contagem total de tokens de conclusão.
summary.total_tokensnumber
Contagem total de tokens.
summary.usage_unit_breakdownarray
Quantidade de uso agrupada por unidade de uso.
breakdowns.by_modelarray
Detalhamento por modelo público solicitado.
breakdowns.by_logical_modelarray
Detalhamento por modelo público lógico.
breakdowns.by_model_vendorarray
Detalhamento por fornecedor do modelo público.
breakdowns.by_scenearray
Detalhamento por cenário da solicitação pública.
breakdowns.daily_costarray
Tendência diária de custos.

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

Parâmetros de consulta

model?string

Filtrar pelo nome do modelo solicitado. Comprimento máximo de 100.

Comprimentolength <= 100
modelVendor?string

Filtrar pelo fornecedor do modelo público. Comprimento máximo de 100.

Comprimentolength <= 100
scene?string

Filtrar por cena de solicitação pública.

Valores permitidos

  • "chat"
  • "image"
  • "audio"
  • "video"
  • "embedding"
  • "rerank"
  • "translation"
  • "music"
  • "3d"
  • "realtime"
  • "systemone"
startDate?string
endDate?string

Resposta

application/json

application/json

application/json

application/json

application/json

Obter uso da API Key

Anterior