Ir para o conteúdo

Listagem de Avatares

Este guia de API fornece uma visão geral do processo para listar avatares e verificar o status dos seus avatares.

Você pode visualizar uma lista de todos os avatares padrão e avatares personalizados e verificar seus status. Use o avatar 'id' para monitorar o progresso, pois o processo de geração pode levar algum tempo. Quando estiver pronto, você pode usar esses avatares para gerar vídeos, aprimorando seu conteúdo com recursos de avatar personalizados. 🦊

Início rápido

Vamos mergulhar e explorar como listar avatares personalizados e padrão.

Listando Avatares Padrão

Este ponto de extremidade recupera todos os avatares padrão fornecidos por nossa plataforma. A resposta contém os campos como 'id', 'thumbnail', 'name' e 'gender' que fornecem detalhes relevantes sobre cada avatar. Você pode usar o 'id' para criar modelo em massa ou solicitações em massa

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

    }
]

Listando Avatares Personalizados

Este endpoint recupera todos os avatares personalizados que você criou. A resposta contém os campos como 'id', 'thumbnail', 'name' e 'gender' que fornecem detalhes relevantes sobre cada avatar. Você pode usar o 'id' para criar modelo em massa ou solicitações em massa

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

Obtenha o status personalizado do avatar

Este ponto de extremidade permite que você verifique o status atual do seu avatar durante o processo de criação. Ao fornecer o avatar específico 'id', você receberá detalhes sobre seu 'status'. Por exemplo, se você fornecer o 'id' 131, a resposta indicará se o avatar foi criado com sucesso, com o 'status' marcado como 'completed' ou outras atualizações 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",
    }
]