GET
/
v1
/
voice-usage
Retrieve TTS API usage data
curl --request GET \
  --url https://supertoneapi.com/v1/voice-usage \
  --header 'x-sup-api-key: <x-sup-api-key>'
{
  "usages": [
    {
      "date": "<string>",
      "voice_id": "<string>",
      "name": "<string>",
      "style": "<string>",
      "language": "<string>",
      "model": "<string>",
      "thumbnail_url": "<string>",
      "total_minutes_used": 123
    }
  ]
}

このAPIは指定した期間中のTTS API使用履歴を照会します。
クローンボイス含め、どのボイスを何分間使用したかを把握できます。

照会日付はUTC+0基準であることにご注意ください。

​
リクエストパラメータ

パラメータ必須説明
start_date✅照会開始日（形式：YYYY-MM-DD、UTC+0基準）
end_date✅照会終了日（形式：YYYY-MM-DD、UTC+0基準）
x-sup-api-key⭕認証用API Key（Headerに含む）

​
例のリクエスト

GET /v1/voice-usage?start_date=2025-05-19&end_date=2025-05-28
x-sup-api-key: [YOUR_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
    }
  ]
}

​
活用例

  • 特定日付別TTS使用量合算
  • どのキャラクター/スタイルが多く使われたかを把握
  • 月別予算管理または内部報告用ログとして活用可能

​
注意事項

  • 照会可能な最大期間は30日です。
  • 該当期間中に使用記録がない場合は空の配列が返されます。
  • total_minutes_usedは実際に生成された音声の長さを基にします。

Headers

​
x-sup-api-key
string
required

The API key to authenticate and authorize access to the service. This key is required for every request.

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

200
application/json

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

The response is of type object.