Saltar a contenido

Lista de avatares

Esta guía de API ofrece una descripción general del proceso para listar avatares y verificar su estado.

Puede ver una lista de todos los avatares predeterminados y personalizados, y verificar su estado. Use el 'id' del avatar para monitorear el progreso, ya que el proceso de generación puede tardar un tiempo. Una vez listo, puede usar estos avatares para generar videos y mejorar su contenido con funciones de avatar personalizadas. 🦊

Inicio rápido.

Profundicemos en cómo listar avatares personalizados y predeterminados.

Listado de avatares predeterminados.

Este endpoint recupera todos los avatares predeterminados proporcionados por nuestra plataforma. La respuesta contiene campos como 'id', 'thumbnail', 'name' y 'gender', que proporcionan detalles relevantes sobre cada avatar. Puede usar el 'id' para crear plantilla masiva o solicitudes masivas

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

    }
]

Listado de avatares personalizados.

Este punto final recupera todos los avatares personalizados que ha creado. La respuesta contiene campos como 'id', 'thumbnail', 'name' y 'gender', que proporcionan información relevante sobre cada avatar. Puede usar el 'id' para crear plantilla masiva o solicitudes masivas

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

Obtener el estado de tu avatar personalizado.

Este punto final te permite consultar el estado actual de tu avatar durante su creación. Al proporcionar el 'id' específico del avatar, recibirás información sobre su 'estado'. Por ejemplo, si proporcionas el 'id' 131, la respuesta indicará si el avatar se ha creado correctamente, con el 'estado' marcado como 'completado' u otras actualizaciones relevantes.

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