Skip to main content
GET
/
v1
/
voices
/
{voice_id}
Get voice details by ID
curl --request GET \
  --url https://supertoneapi.com/v1/voices/{voice_id} \
  --header 'x-sup-api-key: <api-key>'
{
  "voice_id": "<voice-id>",
  "name": "Agatha",
  "description": "",
  "age": "young-adult",
  "gender": "female",
  "use_case": "narration",
  "use_cases": [
    "narration",
    "storytelling"
  ],
  "language": [
    "ar",
    "bg",
    "cs",
    "da",
    "de",
    "el",
    "en",
    "es",
    "et",
    "fi",
    "fr",
    "hi",
    "hu",
    "id",
    "it",
    "ja",
    "ko",
    "nl",
    "pl",
    "pt",
    "ro",
    "ru",
    "vi"
  ],
  "styles": [
    "kind-default",
    "normal",
    "serene"
  ],
  "models": [
    "sona_speech_1",
    "sona_speech_2",
    "supertonic_api_1"
  ],
  "samples": [
    {
      "language": "ko",
      "style": "kind-default",
      "model": "supertonic_api_1",
      "url": "https://example.com/samples/sample-audio.wav"
    }
  ],
  "thumbnail_image_url": "https://example.com/thumbnails/voice-thumbnail.png"
}

​
Endpoint

https://supertoneapi.com/v1/voices/{voice_id}

Authorizations

​
x-sup-api-key
string
header
required

Path Parameters

​
voice_id
string
required

Response

Voice details retrieved successfully

​
voice_id
string
required

Unique identifier for the voice

Example:

"<voice-id>"

​
name
string
required

Name of the voice

Example:

"Agatha"

​
description
string
required

Description of the voice

Example:

""

​
age
string
required

Age of the voice

Example:

"young-adult"

​
gender
string
required

Gender of the voice

Example:

"female"

​
use_case
string
required

Use case of the voice

Example:

"narration"

​
use_cases
string[]
required

Use cases of the voice (array)

Example:
["narration", "storytelling"]
​
language
string[]
required

Languages supported by the voice

Example:
[
  "ar",
  "bg",
  "cs",
  "da",
  "de",
  "el",
  "en",
  "es",
  "et",
  "fi",
  "fr",
  "hi",
  "hu",
  "id",
  "it",
  "ja",
  "ko",
  "nl",
  "pl",
  "pt",
  "ro",
  "ru",
  "vi"
]
​
styles
string[]
required

Styles available for the voice

Example:
["kind-default", "normal", "serene"]
​
models
string[]
required

Models available for the voice

Example:
[
  "sona_speech_1",
  "sona_speech_2",
  "supertonic_api_1"
]
​
samples
object[]

URL to the sample audio file for the voice

​
thumbnail_image_url
string

URL to the thumbnail image for the voice

Example:

"https://example.com/thumbnails/voice-thumbnail.png"