Verwaltung

API-Schlüssel-Nutzung abrufen

Gibt paginierte Nutzungsdetails für einen API-Schlüssel eines Benutzers zurück.

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

Übersicht

Gibt paginierte Nutzungsdatensätze für einen API-Schlüssel zurück.

Abfrageparameter

ParameterTypStandard / GrenzwerteHinweise
pageintegerStandard 1, min 11-basierte Seitennummer
limitintegerStandard 50, min 1, max 100Seitengröße
modelstringmax. Länge 100Angeforderter Modellname
modelVendorstringmax. Länge 100Öffentlicher Modellanbieter
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d, realtime, systemone
startDatestring-Inklusive Untergrenze; akzeptiert RFC3339 mit Zeitzone oder YYYY-MM-DD (00:00 UTC)
endDatestring-Inklusive Obergrenze; akzeptiert RFC3339 mit Zeitzone oder YYYY-MM-DD. Ein reines Datum bedeutet 00:00 UTC zu Beginn des Tages; um einen ganzen Tag einzuschließen, verwenden Sie das nächste Datum oder eine RFC3339-Zeit

Wenn sowohl startDate als auch endDate vorhanden sind, muss startDate vor oder am gleichen Tag wie endDate liegen.

Hinweise

  • Währungsfelder sind nur in USD.

  • Die Antwort ist paginiert.

  • Abgerechnete Datensätze können eine billing_transaction_id enthalten. Speichern Sie diese zusammen mit der request_id, wenn Sie eine Belastung einer Anfrage zuordnen müssen.

  • Datensätze sind nach created_at sortiert, die neuesten zuerst.

  • Ein 429-Fehler mit dem Code report_busy bedeutet, dass die Berichtswarteschlange voll ist. Versuchen Sie es nach den in Retry-After angegebenen Sekunden erneut.

Beispiel

Anfrage

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"

Anfrage / Antwort

Diese Seite stellt das OpenAPI-Schema und kopierbare Anfragebeispiele bereit. Senden Sie Management-Anfragen von Ihrem Terminal oder Client mit einem Management Token; ein direktes Senden ist auf dieser Seite nicht möglich.

Antwortbeispiel

Antwort

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"
      }
    ]
  }
}

Wichtige Felder

api_keyobject
Zusammenfassung des API-Schlüssels unter Verwendung derselben Felder wie bei Listen-, Erstellungs- oder Aktualisierungsantworten.
itemsarray
Paginierte Nutzungszeilen.
paginationobject
Paginierungs-Metadaten mit page, limit, total und totalPages.
summaryobject
Aggregierte Summen für die ausgewählten Filter.
breakdownsobject
Aggregierte Aufschlüsselungen für die ausgewählten Filter.
items[].request_idstring | null
Öffentlicher Anfrage-Identifikator für Support und Abgleich.
items[].billing_transaction_idstring | null
Abgerechnete Transaktions-ID, sofern verfügbar.
items[].modelstring
Angeforderter öffentlicher Modellname.
items[].logical_modelstring
Logisches öffentliches Modell, das für die Berichterstattung verwendet wird.
items[].model_vendorstring | null
Öffentlicher Modellanbieter.
items[].scenestring | null
Öffentliche Anfrageszene.
items[].usage_unitstring
Abrechnungs-Nutzungseinheit, wie z. B. per_token.
items[].usage_quantitynumber
Nutzungsmenge als JSON-Zahl zur Anzeige.
items[].usage_quantity_decimalstring
Genaue Nutzungsmenge als Dezimal-String.
items[].prompt_tokensnumber
Anzahl der Prompt-Token.
items[].completion_tokensnumber
Anzahl der Completion-Token.
items[].total_tokensnumber
Gesamtanzahl der Token.
items[].cache_read_tokensnumber
Anzahl der Cache-Lese-Token.
items[].cache_write_tokensnumber
Gesamtanzahl der Cache-Schreib-Token.
items[].cache_write_tokens_5mnumber
Anzahl der Cache-Schreib-Token (5 Minuten).
items[].cache_write_tokens_1hnumber
Anzahl der Cache-Schreib-Token (1 Stunde).
items[].costnumber
Kosten in USD als JSON-Zahl zur Anzeige.
items[].cost_decimalstring
Genaue Kosten in USD als Dezimal-String.
items[].requested_policystring | null
auto, verified, official, null. Angeforderte Bereitstellungsrichtlinie, sofern aufgezeichnet.
items[].resolved_tierstring | null
verified, official, null. Verwendete Bereitstellungsstufe, sofern aufgezeichnet.
items[].charged_price_basisobject | null
Angewandter Preis und abrechenbare Menge, sofern aufgezeichnet. Bei einer Anfrage mit Tool-Gebühren enthält measure.dimensions webSearchCalls oder groundedPrompts, und effectiveUnitPrices enthält den Preis jedes Aufrufs als webSearch oder groundedPrompt.
items[].created_atstring
ISO-Zeitstempel der Nutzungszeile.
summary.total_requestsnumber
Gesamtanzahl der Anfragen.
summary.total_costnumber
Gesamtkosten in USD als JSON-Zahl zur Anzeige.
summary.total_cost_decimalstring
Genaue Gesamtkosten in USD als Dezimal-String.
summary.total_prompt_tokensnumber
Gesamtzahl der Prompt-Token.
summary.total_completion_tokensnumber
Gesamtzahl der Completion-Token.
summary.total_tokensnumber
Gesamtzahl der Token.
summary.usage_unit_breakdownarray
Nutzungsmenge gruppiert nach Nutzungseinheit.
breakdowns.by_modelarray
Aufschlüsselung nach angefordertem öffentlichem Modell.
breakdowns.by_logical_modelarray
Aufschlüsselung nach logischem öffentlichem Modell.
breakdowns.by_model_vendorarray
Aufschlüsselung nach öffentlichem Modellanbieter.
breakdowns.by_scenearray
Aufschlüsselung nach öffentlicher Anfrageszene.
breakdowns.daily_costarray
Täglicher Kostentrend.

Autorisierung

ManagementTokenAuth
AuthorizationBearer <token>

Management-Token-Authentifizierung. Erstellen oder verwalten Sie Management-Token unter Dashboard > API > Management Tokens.

Ort: header

Pfadparameter

keyId*string

Abfrageparameter

page?integer

Seitennummer (beginnend bei 1). Standard ist 1.

Bereich1 <= value
Standard1
limit?integer

Seitengröße. Standard ist 50, das Maximum ist 100.

Bereich1 <= value <= 100
Standard50
model?string

Nach angefordertem Modellnamen filtern. Maximale Länge 100.

Längelength <= 100
modelVendor?string

Nach öffentlichem Modell-Anbieter filtern. Maximale Länge 100.

Längelength <= 100
scene?string

Nach öffentlicher Anfrageszene filtern.

Zulässige Werte

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

Untergrenze, inklusive. Akzeptiert RFC3339 mit Zeitzone (zum Beispiel 2026-03-28T00:00:00+08:00) oder YYYY-MM-DD, was 00:00 UTC bedeutet.

endDate?string

Obergrenze, inklusive. Akzeptiert RFC3339 mit Zeitzone (zum Beispiel 2026-03-28T23:59:59+08:00) oder YYYY-MM-DD, was 00:00 UTC zu Beginn dieses Tages bedeutet. Um einen ganzen Tag einzuschließen, übergeben Sie das Datum des nächsten Tages oder eine RFC3339-Zeit am Ende des Tages.

Antwort

application/json

application/json

application/json

application/json

application/json

application/json