Création d'avatar
Ce guide API fournit un aperçu de la création d'avatars sur notre plateforme.
Vous pouvez afficher une liste de tous les avatars par défaut et des avatars personnalisés et vérifier leur statut. Utilisez l'avatar 'id' pour suivre la progression, car le processus de génération peut prendre un certain temps. Une fois prêt, vous pouvez utiliser ces avatars pour générer des vidéos, améliorant ainsi votre contenu avec des fonctionnalités d'avatar personnalisées. 🦊
Démarrage rapide
Plongeons-nous dans le vif du sujet et explorons comment créer des avatars instantanés et premium sur notre plateforme.
Créer un avatar instantané
Un avatar instantané est généré rapidement à partir d'une photo que vous fournissez, offrant un moyen rapide de créer un avatar. Pour créer un avatar instantané, vous devez fournir une photo qui adhère à ces directives, car la qualité de l'avatar dépend entièrement de la photo fournie. Faites une demande à l'API pour la création instantanée d'un avatar. Les formats d'image acceptés incluent 'png' et 'jpeg'. Envoyez le fichier et les autres données sous multipart/form-data avec les clés fournies dans l'exemple de demande. Dans la réponse, l'élément « id » est l'élément clé que vous utiliserez pour la demande vidéo groupée. La [vignette] offre un aperçu du nouvel avatar, vous permettant de le consulter avant utilisation. Des informations supplémentaires telles que le [nom], le [genre] et l'utilisateur seront également incluses dans la réponse. Utilisez l'API « statut de l'avatar » (avatar_listing.md) pour vérifier son statut.
curl --request POST \
--url '<https://api.immersive-fox.com/v1/avatar_generation/create_instant_avatar/>' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: multipart/form-data' \
-F 'file=@my_image.png' \
-F 'name=John' \
-F 'gender=Male' \
-F 'remove_background=false'
{
"id": 839,
"thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
"name": "Smith",
"gender": "Male",
"user": 31,
"remove_background": false,
"based_on": "Photo",
"has_hand_wave": false
"generation_time": 20
}
Créer un avatar premium.
Un avatar premium est créé à partir d'une vidéo, ce qui permet d'obtenir une représentation plus réaliste et détaillée. Pour générer un avatar premium à l'aide de notre API, suivez ces étapes :
- Demander les URL pré-signées :
Commencez par demander les URL pré-signées et les noms de fichiers vidéo correspondants au point de terminaison de génération d'URL pré-signées en spécifiant les extensions de fichier (par exemple, « .mp4 ») des vidéos à télécharger. La réponse fournira deux URL pré-signées : une pour la vidéo silencieuse et une pour la vidéo parlée, permettant ainsi un téléchargement direct. De plus, la réponse inclura les noms de fichiers des deux vidéos, qui devront être soumis à l'étape suivante pour générer l'avatar premium.
```bash
curl --request POST \
--url 'https://api.immersive-fox.com/v1/avatar_generation/premium_avatar_presigned_urls/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'Content-Type: multipart/form-data' \
-F 'speaking_video_extention=.mp4' \
-F 'silent_video_extention=.mp4'
```
{
"silent_video_data": {
"presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/silent_videos/31_6f72a1900fd64969ab9f8df465f9e92c.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=72058a2c206ba63726eeda2e88266575c046fa0625f9af1c366b4b9bf921b3ef",
"file_name": "31_6f72a1900fd64969ab9f8df465f9e92c.mp4"
},
"speaking_video_data": {
"presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/31_1e4eb799a3b84639a11c929a6729a1be.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=58e84ccd7d702b64b3400479f27b417f551317ca96afce3e923ac18d9db28bce",
"file_name": "31_1e4eb799a3b84639a11c929a6729a1be.mp4"
}
}
- Télécharger des vidéos avec des URL pré-signées :
Pour générer un avatar premium, vous devez télécharger une vidéo parlante. La vidéo silencieuse est facultative pour améliorer la qualité de l'avatar. Veuillez vous assurer que les deux vidéos respectent les guidelines. Utilisez la méthode PUT avec l'URL pré-signée obtenue à l'étape précédente, valable 30 minutes. Les fichiers vidéo doivent être téléchargés sous forme de données binaires directement vers les URL dans ce délai. === "Requête"
```bash
curl --request PUT \
--url 'https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/{file_name}?<presigned_url_parameters>' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: video/mp4' \
--data-binary '@speaking_video.mp4'
```
=== "Réponse"
```json
{
}
```
--- === "Demande"
```bash
curl --request PUT \
--url 'https://premium-avatar-videos.s3.amazonaws.com/silent_videos/{file_name}?<presigned_url_parameters>' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: video/mp4' \
--data-binary '@silent_video.mp4'
```
=== "Réponse"
```json
{
}
```
- Envoyer une demande de création d'avatar :
Après avoir téléchargé les vidéos, utilisez le 'file_name' obtenu à partir de la requête URL présignée pour générer l'avatar premium. La réponse inclura l''id' du nouvel avatar premium créé, qui sera utilisé pour les demandes de vidéos groupées. De plus, la réponse fournira une 'vignette' qui est un aperçu de l'avatar, ainsi que des détails tels que l''heure de génération', le 'nom', le 'sexe' et d'autres informations pertinentes. Utilisez l'API d'état de l'avatar [avatar_listing.md] pour vérifier l'état de l'avatar. === "Requête"
```bash
curl --request POST \
--url 'https://api.immersive-fox.com/v1/avatar_generation/create_premium_avatar/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'Content-Type: form-data' \
-F 'avatar_name=John' \
-F 'gender=Male' \
-F 'remove_background=false' \
-F 'silent_video_name=31_6f72a1900fd64969ab9f8df465f9e92c.mp4' \
-F 'speaking_video_name=31_1e4eb799a3b84639a11c929a6729a1be.mp4'
```
=== "Réponse"
```bash
{
"id": 840,
"thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
"name": "John",
"gender": "Male",
"user": 31,
"remove_background": true,
"based_on": "Video",
"has_hand_wave": false
"generation_time": 24
}
```