RoomScope

Terakhir diperbarui

Akun

Paket, batas, dan pemakaian kredit workspace pemilik key.

Setiap operasi diautentikasi dengan API key (Authorization: Bearer <key>) dan error memakai amplop bersama yang dijelaskan di Error. Dibuat dari dokumen OpenAPI milik API.

Ambil paket dan batas

GET/v1/entitlements

Paket, modul, batas laju, dan dompet kredit workspace untuk satu periode penagihan: limits.watchlistMax, credits.resetAt (kapan kredit periode tersebut di-reset), exports (ekspor dalam aplikasi saat ini; perDay bernilai null selama tidak ada batas harian), dan money (1 berlian dalam estimasi USD bruto, bagian kreator, dan kurs VND bulanan: estimasi untuk tampilan, bukan pembayaran dari TikTok).

Scopekeys:manageKreditGratis

Parameter query

Parameter query · GET /v1/entitlements
NameTypeDescription
periodOptional
stringAwal periode penagihan, YYYY-MM-01; default ke periode berjalan.

Permintaan

curl "https://api.toktokdata.live/v1/entitlements" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Respons

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "maxApiKeys": 0,      "wsConcurrencyCap": 200,      "maxRoomMinutesPerMonth": 800000,      "historyWindowDays": 365,      "maxSeats": 10,      "seatsUsed": 2,      "exportFormats": [        "csv",        "xlsx"      ],      "watchlistMax": 25    },    "credits": {      "period": "2026-11-01",      "monthlyAllotment": 36000000,      "hardCap": 36000000,      "spent": 0,      "remaining": 0,      "resetAt": "2026-12-01T00:00:00.000Z"    },    "money": {      "diamondUsdGross": 0.01,      "creatorShare": 0.5,      "vndPerUsd": 25500,      "rateLabel": "estimate · 2026-11"    },    "exports": {      "perDay": null,      "usedToday": 1    }  },  "provenance": {    "observedAt": "2026-11-01T11:19:24.411834Z",    "freshness": "near_realtime",    "source": "plan_entitlement",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "entitlements-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Ambil pemakaian kredit

GET/v1/usage

Kredit yang terpakai per operasi dalam satu periode penagihan.

Scopekeys:manageKreditGratis

Parameter query

Parameter query · GET /v1/usage
NameTypeDescription
periodOptional
stringAwal periode penagihan, YYYY-MM-01; default ke periode berjalan.
limitOptional
integerJumlah baris maksimum.

Permintaan

curl "https://api.toktokdata.live/v1/usage" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Respons

200 OK
{  "period": "2026-11-01",  "balance": {    "remaining": 0,    "spent": 0  },  "items": [],  "provenance": {    "observedAt": "2026-11-01T10:00:00.000Z",    "freshness": "near_realtime",    "source": "credit_ledger",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "usage-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.
Apakah halaman ini membantu?