Administración de plantillas
Esta guía de API proporciona una descripción general del uso de plantillas para la generación de solicitudes en masa. --- Las plantillas te permiten agregar y personalizar texto, imágenes, videos, audio, voces y avatares. Si quieres guardar tus configuraciones de video para usarlas en el futuro, crear una plantilla es una mejor opción que generar el video directamente. 🦊 ## Inicio rápido Profundicemos y exploremos cómo crear una plantilla y enumerar tus plantillas, para que puedas generar videos en masa de manera eficiente usándolas más adelante. ## Creación de plantilla Para crear una plantilla de video en masa, usa la siguiente solicitud de API. Te permite definir varias configuraciones, incluido el texto de audio, el avatar y el fondo, para generar una plantilla de video reutilizable de manera eficiente. Personaliza los parámetros para que se ajusten a tus necesidades. Una vez creado, puedes usar el 'id' de la respuesta como 'template_id' en crear solicitudes en masa para generar una solicitud en masa usando esta plantilla. Puede obtener el 'audio_id' y el 'audio_service' de la API de listado de audio y el "csv_id" de la API de listado de csv. Puede usar macros con el formato '{{}}' dentro del 'audio_text', que se reemplazará dinámicamente con los valores del archivo CSV que proporcionó. Por ejemplo, si incluye '{{First Name}}' en su texto, se reemplazará por nombres como "John" y "Smith" para cada entrada correspondiente en el CSV, creando un audio personalizado para cada video de la lista. Admitimos hasta 20 variables de plantilla por solicitud. Asegúrese de que el número y los nombres de estas variables coincidan exactamente en su texto y en el archivo CSV. Los nombres de las variables de plantilla no distinguen entre mayúsculas y minúsculas. Si falta alguna variable de plantilla en el CSV, se devolverá un error.
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,
}
Generación de plantillas con IA.
Immersive Fox ofrece una potente función que automatiza la creación de plantillas. En lugar de diseñar manualmente cada plantilla, puedes aprovechar nuestros modelos de IA para generarlas automáticamente. Simplemente proporciona un texto descriptivo y nuestros algoritmos crearán una plantilla completa que incluye escenas, texto, fondos y voces. Nuestra IA también utilizará los datos del archivo CSV especificado durante la generación masiva de videos. Esto te permite crear fácilmente campañas de marketing personalizadas para tus clientes. Puedes especificar qué campos del CSV se usarán en el video, proporcionando el campo optional_params_for_scripts en la carga útil. Usa el siguiente comando curl para solicitar una plantilla generada por 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,
}
Plantilla de listado
Para listar todas las plantillas creadas por el usuario, utilice la siguiente solicitud de API. Esta devuelve detalles de todas las plantillas, lo que le permite revisarlas y administrarlas. Una vez que tenga las plantillas, puede usar el 'id' de cualquiera de ellas como 'template_id' en crear solicitudes masivas para generar una solicitud masiva usando esta plantilla.
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
}
]
Obtener detalles de la plantilla.
Para obtener detalles de una plantilla específica, utilice la siguiente solicitud de API. Esta proporciona información sobre la plantilla seleccionada, lo que le permite ver las configuraciones antes de generar solicitudes masivas. Una vez que tenga los detalles de la plantilla, puede usar el 'id' como 'template_id' en crear solicitudes masivas para generar solicitudes masivas usando esta plantilla.
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,
}