最終更新
クレジット
すべてのワークスペースには、請求期間ごとに補充されるクレジットウォレットがあります。API の呼び出しとダッシュボードの読み取りは同じウォレットから消費されます。各操作の種類はリファレンスに記載されています。
操作ごとのコスト
| 種類 | 1 回あたりのクレジット | 対象 |
|---|---|---|
| キャッシュの閲覧 | 1 | 保存済みデータのすべての読み取り：ランキング、クリエイター、インサイト、動画、コメント、トレンド、LIVE セッション。API キーの一覧取得（GET /v1/api-keys）もキャッシュの閲覧に含まれます。 |
| フォローリスト | 4,000 | GET /v1/creators/{uid}/following または /followers で、リストを新たに収集する必要がある場合（それ以外の場合は 1）。 |
| コメント | 500 | GET /v1/videos/{id}/comments で、コメントを新たに収集する必要がある場合（それ以外の場合は 1）。 |
| プロフィールの解決 | 1,250 | GET /v1/creators/{uid} で古いプロフィールを再取得する場合、読み取りに加えて課金されます。プロフィールが返ってきた場合のみ課金されます。 |
| ライブ状態の更新 | 1,250 | POST /v1/live/creators/{uid}/refresh：クリエイターを今すぐ確認するようワーカーに依頼します。 |
| エクスポート | 2,500 | POST /v1/exports：CSV または Excel ファイルを作成します。 |
| Webhook の配信 | 1 | アラートルールが配信する Webhook 1 件ごと。ルールのテストで送信されるものも含みます。 |
| 無料 | 0 | アラートルールの管理、エクスポートの一覧とダウンロード、キーの作成と失効、利用権限と使用量の確認。 |
リファレンスの各操作には、スコープの横にその種類が表示されます。202 レスポンス（収集がまだ進行中）は、キャッシュの閲覧として課金されます。
毎月の付与分
暦月（UTC）ごとに、その月の最初の計量対象の呼び出しまたはウォレットの読み取りの時点で、ワークスペースのプランに応じた付与分が与えられます。1 か月の消費は付与分を超えられません。プランについては 料金 をご覧ください。
| プラン | 1 か月あたりのクレジット |
|---|---|
| Free | 150,000 |
| Starter | 450,000 |
| Pro | 3,000,000 |
| Scale | 12,000,000 |
| Agency / Enterprise | 36,000,000 |
ウォレットが空になったとき
上限を超える計量対象の呼び出しは、通常の エラーエンベロープ で、コード credit_cap_exceeded とともに 402 を返します。無料の操作は引き続き利用できます。ウォレットは翌月の初めに補充されます。月の途中でアップグレードすると上限が引き上げられます。
失敗した呼び出しは課金されません
クレジットは呼び出しの開始時に確保され、失敗した場合は解放されます。そのため
4xx や 5xx のレスポンスにコストはかかりません。2xx または 3xx は課金されます。ウォレットを確認する
GET /v1/entitlements は、現在の期間のプラン、制限、ウォレットを返します。GET /v1/usage は消費を操作ごとに内訳表示します。どちらも無料で、keys:manage スコープが必要です。
bash
curl "https://api.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" # data.credits: { "period": "2026-11-01", "monthlyAllotment": …, "hardCap": …, "spent": …, "remaining": … }このページは役に立ちましたか？