Skip to content

Voice Listing

This API guide provides an overview of how to list available voices on our platform.

By using this API, you will be able to retrieve a complete list of all available voices, including both default and personalized options. To generate bulk video requests, you will need the 'id' and the corresponding 'voice_service_name' to efficiently process and manage multiple requests across our platform. 🎧🎬

Quick Start

Let’s explore how to get the voice details, so you can easily access and use it in your videos. 🎧✨

Listing Default Voices

This API provides a list of default voices. Select a voice from the list and record its 'id' and 'voice_service_name', which are required for use in templates creation or bulk requests creation.

curl --request GET \
     --url 'https://api.immersive-fox.com/v1/voice/default_voices/'  \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: application/json' 

[
    {
        "id": 2,
        "language": "Afrikaans",
        "label": "󰑠 Afrikaans - Informative",
        "gender": "Female",
        "language_code": "af-ZA",
        "voice_service_name": "google_audio"
    }
]

Listing Personalized Voices

This API provides a list of personalized voices. Select a voice from the list and record its 'id' and 'voice_service_name', which are required for use in templates creation or bulk requests creation.

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/voice/personalized_voices/' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: application/json'  

[
    {
        "id": 2,
        "language": "Afrikaans",
        "supported_languages": [
            {
                "name": "Greek",
                "language_code": "el-GR"
            },
            {
                "name": "Russian",
                "language_code": "ru-RU"
            }
        ],
        "label": "👤 My voice",
        "default_language": "en-US",
        "gender": "Male",
        "audio_id": "QqH3AY53vGZpD1HCthXE",
        "user": 31,
        "voice_service_name": "resemble_audio"
    }
]

Check Personalized Voice Status

To check the status of a generated personalized voice, you need to provide the 'id' in your request. The status of the voice generation process will be included in the response under the 'status' field. Use this information to monitor the progress and determine the completion state of your personalized voice.

curl --request GET \
    --url 'https://api.immersive-fox.com/v1/voice/status/<voice_id>' \
    --header 'X-Api-Key: <your-api-key>' \
    --header 'Content-Type: application/json'  

{
    "id": 2,
    "language": "Afrikaans",
    "supported_languages": [
        {
            "name": "Greek",
            "language_code": "el-GR"
        },
        {
            "name": "Russian",
            "language_code": "ru-RU"
        }
    ],
    "label": "👤 My voice",
    "default_language": "en-US",
    "gender": "Female",
    "audio_id": "QqH3AY53vGZpD1HCthXE",
    "user": 31,
    "status": "Completed",
    "voice_service_name": "resemble_audio"
}