Skip to main content
GET
/
v1
/
voice-usage
Retrieve TTS API usage data
curl --request GET \
  --url https://supertoneapi.com/v1/voice-usage \
  --header 'x-sup-api-key: <api-key>'
{
  "usages": [
    {
      "date": "<string>",
      "voice_id": "<string>",
      "total_minutes_used": 123,
      "name": "<string>",
      "style": "<string>",
      "language": "<string>",
      "model": "<string>",
      "thumbnail_url": "<string>"
    }
  ]
}
このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は英語の原文もあわせてご確認ください。
指定期間における (date, voice, style, language, model) の組み合わせごとに、生成オーディオの分数を返します。プリセットボイスとカスタムボイスの両方がレスポンスに含まれます。 カスタム内訳（例: api_key 別）を含むバケット分析が必要な場合は、代わりに 使用量取得 をご利用ください。
日付は UTC+0 です。クエリ期間は最大 30 日 までです。

​
エンドポイント

GET https://supertoneapi.com/v1/voice-usage

​
クエリパラメータ

NameRequiredDescription
start_date✅YYYY-MM-DD 形式（UTC+0）の開始日です。
end_date✅YYYY-MM-DD 形式（UTC+0）の終了日です。

​
リクエスト例

GET /v1/voice-usage?start_date=2025-05-19&end_date=2025-05-28
x-sup-api-key: $SUPERTONE_API_KEY

​
レスポンス例

{
  "usages": [
    {
      "date": "2025-05-22",
      "voice_id": "e5f6fb1a53d0add87afb4f",
      "name": "Agatha",
      "style": "neutral",
      "language": "en",
      "model": "sona_speech_1",
      "total_minutes_used": 12.43251349
    },
    {
      "date": "2025-05-24",
      "voice_id": "opSGuRvHBe7EfZ4LQga1hE",
      "name": "My Voice 1",
      "style": "sad",
      "language": "ko",
      "model": "sona_speech_1",
      "total_minutes_used": 3.24566213
    }
  ]
}

​
注意事項

  • 指定期間内に使用記録がない場合、usages は空の配列となります。
  • total_minutes_used は実際に生成されたオーディオの長さ（クレジット差し引きにも使用される値）を反映します。
  • 月次の予算レポートや、コスト要因となるキャラクターの特定に有用です。

​
関連項目

Docs: Cost and usage

週次レポート、異常検知アラート、按分などの運用パターン。

Get usage

多次元の内訳に対応したバケット分析。

Authorizations

​
x-sup-api-key
string
header
required

Query Parameters

​
start_date
string
required

The start date in YYYY-MM-DD format.

Example:

"2024-11-01"

​
end_date
string
required

The end date in YYYY-MM-DD format.

Example:

"2024-11-30"

Response

A list of TTS API usage records matching the specified date range.

​
usages
object[]
required