Gestion des modèles
Ce guide API fournit un aperçu de l'utilisation de modèles pour la génération de requêtes en masse.
Les modèles vous permettent d'ajouter et de personnaliser du texte, des images, des vidéos, de l'audio, des voix et des avatars. Si vous souhaitez enregistrer vos configurations vidéo pour une utilisation ultérieure, la création d'un modèle est une meilleure option que la génération directe de la vidéo. 🦊
Démarrage rapide
Plongeons-nous dans le vif du sujet et explorons comment créer un modèle et répertorier vos modèles, afin que vous puissiez générer efficacement des vidéos en masse en les utilisant plus tard.
Création d'un modèle
Pour créer un modèle de vidéo en masse, utilisez la requête API suivante. Elle vous permet de définir divers paramètres, notamment le texte audio, l'avatar et l'arrière-plan, pour générer efficacement un modèle vidéo réutilisable. Personnalisez les paramètres en fonction de vos besoins. Une fois créé, vous pouvez utiliser le 'id' de la réponse comme 'template_id' dans create bulk requests pour générer une requête en masse à l'aide de ce modèle. Vous pouvez obtenir les identifiants audio et service audio depuis l'API de liste audio (audio_generation.md) et le csv depuis l'API de liste csv (manage_csv.md). Vous pouvez utiliser des macros au format {{}}} dans le texte audio, qui seront remplacées dynamiquement par les valeurs du fichier CSV fourni. Par exemple, si vous incluez {{Prénom}} dans votre texte, il sera remplacé par des noms tels que « John » et « Smith » pour chaque entrée correspondante du fichier CSV, créant ainsi un son personnalisé pour chaque vidéo de la liste. Nous prenons en charge jusqu'à 20 variables de modèle par requête. Assurez-vous que le nombre et les noms de ces variables correspondent exactement entre votre texte et le fichier CSV. Les noms des variables de modèle ne sont pas sensibles à la casse. Si des variables de modèle sont manquantes dans le fichier CSV, une erreur sera renvoyée.
curl --request POST \
--url 'https://api.immersive-fox.com/v1/template/create_bulk_template/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data { \
"csv_id": 45, \
"template_name": "My new template", \
"configurations": [ \
{ \
"audio_text": "Hi, My name is {{First Name}}", \
"avatar": 102, \
"avatar_size": 76, \
"background_color": "#ffffff", \
"background_music_is_personalized": "system", \
"background_music_volume": 0.1, \
"frame_height": 1080, \
"frame_width": 1920, \
"is_personalized_audio": false, \
"scene_number": 1, \
"scene_transition": "none", \
"audio_id": 2, \
"audio_service": "google_audio", \
"user_voice_speed": 1, \
"x_position": 0.604931, \
"y_position": 0.43101 \
} \
] \
}
{
"id": 1142,
"project_name": "My new template",
"csv_id": 45,
"user": 31,
}
Génération de modèles avec l'IA :
Immersive Fox propose une fonctionnalité puissante qui automatise la création de modèles. Au lieu de concevoir chaque modèle manuellement, vous pouvez utiliser nos modèles d'IA pour les générer. Fournissez simplement un texte descriptif et nos algorithmes créeront un modèle complet comprenant scènes, texte, arrière-plans et voix. Notre IA utilisera également les données du fichier CSV spécifié lors de la génération de vidéos en masse. Cela vous permet de créer facilement des campagnes marketing personnalisées pour vos clients. Vous pouvez spécifier les champs du fichier CSV à utiliser dans la vidéo en ajoutant le champ « optional_params_for_scripts » dans la charge utile. Utilisez la commande curl suivante pour demander un modèle généré par l'IA :
curl --request POST \
--url 'https://api.immersive-fox.com/v1/template/generate_bulk_template_with_ai/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data { \
"avatar_gender": "female", # male / female \
"template_name": "Project_01", \
"target_audience" : "Subscribers of Spotify", \
"description" : "Tell our users that their subscription is going to finish soon", \
"main_language" : "English", \
"goal" : "Renew Subscription", \
"allow_third_party_ml_models": true, \
"length": "long", # short / medium / long \
"optional_params_for_scripts": ["person_name", "subscription_type", "subscription_charges"] \
}
{
"id": 1142,
"project_name": "Project_01",
"user": 31,
}
Liste des modèles :
pour lister tous les modèles créés par l'utilisateur, utilisez la requête API suivante. Elle renvoie les détails de tous les modèles, vous permettant de les consulter et de les gérer. Une fois les modèles disponibles, vous pouvez utiliser l'identifiant de n'importe lequel de ces modèles comme identifiant de modèle dans créer des requêtes groupées pour générer des requêtes groupées à partir de ce modèle.
curl --request GET \
--url 'https://api.immersive-fox.com/v1/template/bulk_templates' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json'
[
{
"id": 1112,
"project_name": "My old template",
"csv_id": 41,
"user": 31
},
{
"id": 1142,
"project_name": "My new template",
"csv_id": 45,
"user": 31
}
]
Obtenir les détails d'un modèle :
pour obtenir les détails d'un modèle spécifique, utilisez la requête API suivante. Elle fournit des informations sur le modèle sélectionné, vous permettant de visualiser les configurations avant la génération de requêtes groupées. Une fois les détails du modèle obtenus, vous pouvez utiliser l'identifiant comme identifiant de modèle dans créer des requêtes groupées pour générer des requêtes groupées à partir de ce modèle.
curl --request GET \
--url 'https://api.immersive-fox.com/v1/template/bulk_template/<template_id>' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json'
{
"csv_id": 47,
"template_name": "My new template",
"configurations": [ {
"audio_text": "Hi, My name is {{First Name}}",
"avatar": 223,
"avatar_size": 75,
"background_color": "#ffffff",
"background_music_is_personalized": "system",
"background_music_volume": 0.1,
"frame_height": 1080,
"frame_width": 1920,
"is_personalized_audio": false,
"scene_number": 1,
"scene_transition": "none",
"audio_id": 2,
"audio_service": "google_audio",
"user_voice_speed": 1,
"x_position": 0.604931,
"y_position": 0.431010,
}