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
    }
  ]
}
This API queries TTS API usage history for a specified period.
You can understand which voices, including cloned voices, were used for how many minutes.
Please note that dates are based on UTC+0.

โ€‹
Request Parameters

ParameterRequiredDescription
start_dateโœ…Inquiry start date (format: YYYY-MM-DD, UTC+0 based)
end_dateโœ…Inquiry end date (format: YYYY-MM-DD, UTC+0 based)
x-sup-api-keyโญ•API Key for authentication (included in Header)

โ€‹
Request Example

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

โ€‹
Response Example

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

โ€‹
Tips

  • TTS usage aggregation by specific date
  • Understanding which characters/styles were used most
  • Can be used for monthly budget management or internal reporting logs

โ€‹
Important Notes

  • Maximum inquiry period is 30 days.
  • If there are no usage records during the period, an empty array is returned.
  • total_minutes_used is based on the length of actually generated speech.

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.