TokenLab

Gestion

Obtenir l'utilisation d'une clé API

Renvoie les détails d'utilisation paginés pour une clé API utilisateur.

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

Aperçu

Renvoie les enregistrements d'utilisation paginés pour une clé API.

Paramètres de requête

ParamètreTypeDéfaut / LimitesNotes
pageintegerdéfaut 1, min 1Numéro de page commençant à 1
limitintegerdéfaut 50, min 1, max 100Taille de la page
modelstringlongueur max 100Nom du modèle demandé
modelVendorstringlongueur max 100Fournisseur du modèle public
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d, realtime, systemone
startDatestring-Borne inférieure inclusive ; accepte le format RFC3339 avec fuseau horaire ou YYYY-MM-DD (00:00 UTC)
endDatestring-Borne supérieure inclusive ; accepte le format RFC3339 avec fuseau horaire ou YYYY-MM-DD. Une valeur de date seule signifie 00:00 UTC au début de ce jour ; pour inclure une journée entière, utilisez la date suivante ou une heure RFC3339

Si startDate et endDate sont tous deux présents, startDate doit être antérieur ou égal à endDate.

Notes

  • Les champs monétaires sont uniquement en USD.

  • La réponse est paginée.

  • Les enregistrements réglés peuvent inclure billing_transaction_id. Enregistrez-le avec request_id lorsque vous devez faire correspondre une facturation à une requête.

  • Les enregistrements sont triés par created_at, du plus récent au plus ancien.

  • Une erreur 429 avec le code report_busy signifie que la file d'attente des rapports est pleine. Réessayez après le délai indiqué dans Retry-After (en secondes).

Exemple

Requête

cURL
curl "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456/usage?page=1&limit=20&scene=chat&startDate=2026-07-01&endDate=2026-07-31T23:59:59Z" \
  -H "Authorization: Bearer mt-your-management-token"

Requête / Réponse

Cette page fournit le schéma OpenAPI et des exemples de requêtes copiables. Envoyez les requêtes de gestion depuis votre terminal ou client avec un Management Token ; l'envoi direct n'est pas disponible sur cette page.

Exemple de réponse

Réponse

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-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
  },
  "items": [
    {
      "request_id": "req_abc123",
      "billing_transaction_id": "billtxn_abc123",
      "model": "gpt-5.6-luna",
      "logical_model": "gpt-5.6-luna",
      "model_vendor": "OpenAI",
      "scene": "chat",
      "usage_unit": "per_token",
      "usage_quantity": 1500,
      "usage_quantity_decimal": "1500",
      "prompt_tokens": 1000,
      "completion_tokens": 500,
      "total_tokens": 1500,
      "cache_read_tokens": 0,
      "cache_write_tokens": 0,
      "cache_write_tokens_5m": 0,
      "cache_write_tokens_1h": 0,
      "cost": 0.0012,
      "cost_decimal": "0.0012",
      "created_at": "2026-07-08T03:15:00.000Z",
      "requested_policy": null,
      "resolved_tier": null,
      "charged_price_basis": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  },
  "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"
      }
    ]
  }
}

Champs importants

api_keyobject
Résumé de la clé API utilisant les mêmes champs que les réponses de liste/création/mise à jour.
itemsarray
Lignes d'utilisation paginées.
paginationobject
Métadonnées de pagination avec page, limit, total et totalPages.
summaryobject
Totaux agrégés pour les filtres sélectionnés.
breakdownsobject
Ventilations agrégées pour les filtres sélectionnés.
items[].request_idstring | null
Identifiant de requête public pour le support et le rapprochement.
items[].billing_transaction_idstring | null
Identifiant de transaction de facturation réglée lorsqu'il est disponible.
items[].modelstring
Nom du modèle public demandé.
items[].logical_modelstring
Modèle public logique utilisé pour le reporting.
items[].model_vendorstring | null
Fournisseur du modèle public.
items[].scenestring | null
Scène de requête publique.
items[].usage_unitstring
Unité d'utilisation de facturation, telle que per_token.
items[].usage_quantitynumber
Quantité d'utilisation sous forme de nombre JSON pour l'affichage.
items[].usage_quantity_decimalstring
Quantité d'utilisation exacte sous forme de chaîne décimale.
items[].prompt_tokensnumber
Nombre de jetons de prompt.
items[].completion_tokensnumber
Nombre de jetons de complétion.
items[].total_tokensnumber
Nombre total de jetons.
items[].cache_read_tokensnumber
Nombre de jetons de lecture en cache.
items[].cache_write_tokensnumber
Nombre total de jetons d'écriture en cache.
items[].cache_write_tokens_5mnumber
Nombre de jetons d'écriture en cache sur cinq minutes.
items[].cache_write_tokens_1hnumber
Nombre de jetons d'écriture en cache sur une heure.
items[].costnumber
Coût en USD sous forme de nombre JSON pour l'affichage.
items[].cost_decimalstring
Coût exact en USD sous forme de chaîne décimale.
items[].requested_policystring | null
auto, verified, official, null. Politique de livraison demandée, lorsqu'elle est enregistrée.
items[].resolved_tierstring | null
verified, official, null. Niveau de livraison utilisé, lorsqu'il est enregistré.
items[].charged_price_basisobject | null
Prix appliqué et quantité facturable, lorsqu'ils sont enregistrés. Pour une requête avec des frais d'outils, measure.dimensions inclut webSearchCalls ou groundedPrompts, et effectiveUnitPrices inclut le prix de chaque appel en tant que webSearch ou groundedPrompt.
items[].created_atstring
Horodatage ISO de la ligne d'utilisation.
summary.total_requestsnumber
Nombre total de requêtes.
summary.total_costnumber
Coût total en USD sous forme de nombre JSON pour l'affichage.
summary.total_cost_decimalstring
Coût total exact en USD sous forme de chaîne décimale.
summary.total_prompt_tokensnumber
Total des jetons de prompt.
summary.total_completion_tokensnumber
Total des jetons de complétion.
summary.total_tokensnumber
Total des jetons.
summary.usage_unit_breakdownarray
Quantité d'utilisation regroupée par unité d'utilisation.
breakdowns.by_modelarray
Ventilation par modèle public demandé.
breakdowns.by_logical_modelarray
Ventilation par modèle public logique.
breakdowns.by_model_vendorarray
Ventilation par fournisseur de modèle public.
breakdowns.by_scenearray
Ventilation par scène de requête publique.
breakdowns.daily_costarray
Tendance du coût quotidien.

Autorisation

ManagementTokenAuth
AuthorizationBearer <token>

Authentification par jeton de gestion. Créez ou gérez vos jetons de gestion dans Dashboard > API > Management Tokens.

Emplacement: header

Paramètres de chemin

keyId*string

Paramètres de requête

page?integer

Numéro de page commençant à 1. La valeur par défaut est 1.

Plage1 <= value
par défaut1
limit?integer

Taille de la page. La valeur par défaut est 50 et le maximum est 100.

Plage1 <= value <= 100
par défaut50
model?string

Filtrer par nom de modèle demandé. Longueur maximale 100.

Longueurlength <= 100
modelVendor?string

Filtrer par fournisseur de modèle public. Longueur maximale 100.

Longueurlength <= 100
scene?string

Filtrer par scène de requête publique.

Valeurs possibles

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

Borne inférieure, inclusive. Accepte le format RFC3339 avec fuseau horaire (par exemple 2026-03-28T00:00:00+08:00) ou YYYY-MM-DD, ce qui signifie 00:00 UTC.

endDate?string

Borne supérieure, inclusive. Accepte le format RFC3339 avec fuseau horaire (par exemple 2026-03-28T23:59:59+08:00) ou YYYY-MM-DD, ce qui signifie 00:00 UTC au début de ce jour. Pour inclure une journée entière, passez la date du jour suivant ou une heure RFC3339 à la fin de la journée.

Réponse

application/json

application/json

application/json

application/json

application/json

application/json