Skip to content

Avatar Listing

This API guide provides an overview of the process for listing avatars and checking the status of your avatars.

You can view a list of all default avatars and personalized avatars and check their status. Use the avatar 'id' to monitor progress, as the generation process may take some time. Once ready, you can use these avatars to generate videos, enhancing your content with personalized avatar features. 🦊

Quick Start

Let’s dive in and explore how to list personalized and default avatars.

Listing Default Avatars

This endpoint retrieves all default avatars provided by our platform. The response contains the fields such as 'id', 'thumbnail', 'name', and 'gender' which provide relevant details about each avatar.

You can use the 'id' to create bulk template or bulk rquests

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

[
    {
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Riley",
        "gender": "Male",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false

    }
]

Listing Personalized Avatars

This endpoint retrieves all personalized avatars that you have created. The response contains the fields such as 'id', 'thumbnail', 'name', and 'gender' which provide relevant details about each avatar.

You can use the 'id' to create bulk template or bulk rquests

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

[
    { 
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Lucy",
        "gender": "Female",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false
        "status": "Completed",
    }
]

Get Personalized Avatar Status

This endpoint enables you to check the current status of your avatar during its creation process. By providing the specific avatar 'id', you will receive details regarding its 'status'. For example, if you provide the 'id' 131, the response will indicate whether the avatar has been successfully created, with the 'status' marked as 'completed' or other relevant updates.

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

[
    {
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Lucy",
        "gender": "Female",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false
        "status": "Completed",
    }
]