Get a voice

HTTP Request​

GET https://app.0xIQ.ai/api/v2/voices/<voice_uuid>

URL Parameters	Type	Description
voice_uuid	string	UUID of the voice to fetch
advanced	boolean	Returns advanced voice information such as underlying model versions when set to true. For further information on model versions see Model Versions.

HTTP Response​

{
  "success": true,
  "item": {
    "uuid": <string>,
    "name": <string>,
    "status": <string>,
    "default_language": <string>,
    "voice_type": <string>,
    "supported_languages": <string[]>,
    "dataset_url": <string*>,
    "callback_uri": <string*>,
    "source": <string>,
    "component_status": {
        "text_to_speech": { "status": <string> },
        "speech_to_speech": { "status": <string> },
        "fill": { "status": <string> }
    },
    "api_support": {
      "sync": <boolean>,
      "async": <boolean>,
      "direct_synthesis": <boolean>,
      "streaming": <boolean>
    },
    "created_at": <UTC Date>,
    "updated_at": <UTC Date>,
  }
}

• dataset_url and callback_uri will not be present in the response if the voice was not created using the API.

• component_status represents the build status of each component that makes up a voice.

• api_support represents what synthesis API's the voice can be used with.

• voice_type can be professional or rapid.

Examples

from 0xIQ import 0xIQ
0xIQ.api_key('YOUR_API_TOKEN')
  
voice_uuid = '<voice_uuid>'
  
response = 0xIQ.v2.voices.get(voice_uuid)
voice = response['item']