Manajemen

Mendapatkan Penggunaan API Key

Mengembalikan detail penggunaan yang dipaginasi untuk API key pengguna.

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

Ringkasan

Mengembalikan catatan penggunaan yang dipaginasi untuk satu API key.

Parameter Kueri

ParameterTipeDefault / BatasCatatan
pageintegerdefault 1, min 1Nomor halaman berbasis 1
limitintegerdefault 50, min 1, max 100Ukuran halaman
modelstringmax length 100Nama model yang diminta
modelVendorstringmax length 100Vendor model publik
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d, realtime, systemone
startDatestring-Batas bawah inklusif; menerima RFC3339 dengan zona waktu atau YYYY-MM-DD (00:00 UTC)
endDatestring-Batas atas inklusif; menerima RFC3339 dengan zona waktu atau YYYY-MM-DD. Nilai tanggal saja berarti 00:00 UTC di awal hari tersebut, jadi untuk menyertakan satu hari penuh gunakan tanggal berikutnya atau waktu RFC3339

Jika startDate dan endDate keduanya ada, startDate harus lebih awal dari atau sama dengan endDate.

Catatan

  • Bidang moneter hanya dalam USD.

  • Respons dipaginasi.

  • Catatan yang telah diselesaikan dapat menyertakan billing_transaction_id. Simpan ID tersebut bersama request_id saat Anda perlu mencocokkan tagihan dengan permintaan.

  • Catatan diurutkan berdasarkan created_at, yang terbaru terlebih dahulu.

  • Kode 429 dengan kode report_busy berarti antrean laporan penuh. Coba lagi setelah detik yang ditentukan dalam Retry-After.

Contoh

Permintaan

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"

Permintaan / Respons

Halaman ini menyediakan skema OpenAPI dan contoh permintaan yang dapat disalin. Kirim permintaan manajemen dari terminal atau klien Anda dengan Management Token; pengiriman langsung tidak tersedia di halaman ini.

Contoh respons

Respons

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

Bidang penting

api_keyobject
Ringkasan API key menggunakan bidang yang sama dengan respons list/create/update.
itemsarray
Baris penggunaan yang dipaginasi.
paginationobject
Metadata paginasi dengan page, limit, total, dan totalPages.
summaryobject
Total agregat untuk filter yang dipilih.
breakdownsobject
Rincian agregat untuk filter yang dipilih.
items[].request_idstring | null
Pengidentifikasi permintaan publik untuk dukungan dan rekonsiliasi.
items[].billing_transaction_idstring | null
ID transaksi penagihan yang telah diselesaikan jika tersedia.
items[].modelstring
Nama model publik yang diminta.
items[].logical_modelstring
Model publik logis yang digunakan untuk pelaporan.
items[].model_vendorstring | null
Vendor model publik.
items[].scenestring | null
Scene permintaan publik.
items[].usage_unitstring
Unit penggunaan penagihan, seperti per_token.
items[].usage_quantitynumber
Kuantitas penggunaan sebagai angka JSON untuk tampilan.
items[].usage_quantity_decimalstring
Kuantitas penggunaan eksak sebagai string desimal.
items[].prompt_tokensnumber
Jumlah token prompt.
items[].completion_tokensnumber
Jumlah token completion.
items[].total_tokensnumber
Jumlah total token.
items[].cache_read_tokensnumber
Jumlah token cache read.
items[].cache_write_tokensnumber
Jumlah total token cache write.
items[].cache_write_tokens_5mnumber
Jumlah token cache write lima menit.
items[].cache_write_tokens_1hnumber
Jumlah token cache write satu jam.
items[].costnumber
Biaya dalam USD sebagai angka JSON untuk tampilan.
items[].cost_decimalstring
Biaya eksak dalam USD sebagai string desimal.
items[].requested_policystring | null
auto, verified, official, null. Kebijakan pengiriman yang diminta, saat dicatat.
items[].resolved_tierstring | null
verified, official, null. Tingkat pengiriman yang digunakan, saat dicatat.
items[].charged_price_basisobject | null
Harga yang diterapkan dan kuantitas yang dapat ditagih, saat dicatat. Untuk permintaan dengan biaya alat, measure.dimensions mencakup webSearchCalls atau groundedPrompts, dan effectiveUnitPrices mencakup harga setiap panggilan sebagai webSearch atau groundedPrompt.
items[].created_atstring
Stempel waktu baris penggunaan ISO.
summary.total_requestsnumber
Jumlah total permintaan.
summary.total_costnumber
Total biaya dalam USD sebagai angka JSON untuk tampilan.
summary.total_cost_decimalstring
Total biaya eksak dalam USD sebagai string desimal.
summary.total_prompt_tokensnumber
Total token prompt.
summary.total_completion_tokensnumber
Total token completion.
summary.total_tokensnumber
Total token.
summary.usage_unit_breakdownarray
Kuantitas penggunaan dikelompokkan berdasarkan unit penggunaan.
breakdowns.by_modelarray
Rincian berdasarkan model publik yang diminta.
breakdowns.by_logical_modelarray
Rincian berdasarkan model publik logis.
breakdowns.by_model_vendorarray
Rincian berdasarkan vendor model publik.
breakdowns.by_scenearray
Rincian berdasarkan scene permintaan publik.
breakdowns.daily_costarray
Tren biaya harian.

Otorisasi

ManagementTokenAuth
AuthorizationBearer <token>

Autentikasi token manajemen. Buat atau kelola Management Token di Dashboard > API > Management Tokens.

Lokasi: header

Parameter path

keyId*string

Parameter query

page?integer

Nomor halaman berbasis 1. Default adalah 1.

Rentang1 <= value
bawaan1
limit?integer

Ukuran halaman. Default adalah 50 dan maksimum adalah 100.

Rentang1 <= value <= 100
bawaan50
model?string

Filter berdasarkan nama model yang diminta. Panjang maksimum 100.

Panjanglength <= 100
modelVendor?string

Filter berdasarkan vendor model publik. Panjang maksimum 100.

Panjanglength <= 100
scene?string

Filter berdasarkan skenario permintaan publik.

Nilai yang tersedia

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

Batas bawah, inklusif. Menerima RFC3339 dengan zona waktu (misalnya 2026-03-28T00:00:00+08:00) atau YYYY-MM-DD, yang berarti 00:00 UTC.

endDate?string

Batas atas, inklusif. Menerima RFC3339 dengan zona waktu (misalnya 2026-03-28T23:59:59+08:00) atau YYYY-MM-DD, yang berarti 00:00 UTC pada awal hari tersebut. Untuk menyertakan satu hari penuh, masukkan tanggal hari berikutnya atau waktu RFC3339 di akhir hari.

Respons

application/json

application/json

application/json

application/json

application/json

application/json