Gerindo modelos
Este guia de API fornece uma visão geral do uso de modelos para geração de solicitações em massa.
--- Os modelos permitem que você adicione e personalize texto, imagens, vídeos, áudio, vozes e avatares. Se você quiser salvar suas configurações de vídeo para uso futuro, criar um modelo é uma opção melhor do que gerar o vídeo diretamente. 🦊
Início rápido
Vamos mergulhar e explorar como criar um modelo e listar seus modelos, para que você possa gerar vídeos em massa com eficiência usando-os mais tarde.
Criando modelo
Para criar um modelo de vídeo em massa, use a seguinte solicitação de API. Ela permite que você defina várias configurações, incluindo texto de áudio, avatar e plano de fundo, para gerar um modelo de vídeo reutilizável com eficiência. Personalize os parâmetros para atender às suas necessidades. Depois de criado, você pode usar o 'id' da resposta como 'template_id' em criar solicitações em massa para gerar uma solicitação em massa usando este modelo. Você pode obter o 'audio_id' e o 'audio_service' da API de listagem de áudio e o "csv_id" da API de listagem de csv. Você pode usar macros no formato '{{}}' dentro do 'audio_text', que será substituído dinamicamente por valores do arquivo CSV fornecido. Por exemplo, se você incluir '{{First Name}}' no seu texto, ele será substituído por nomes como "John" e "Smith" para cada entrada correspondente no CSV, criando áudio personalizado para cada vídeo na lista. Oferecemos suporte a até 20 variáveis de modelo por solicitação. Certifique-se de que o número e os nomes dessas variáveis correspondam exatamente entre seu texto e o arquivo CSV. Os nomes das variáveis de modelo não diferenciam maiúsculas de minúsculas. Se alguma variável de modelo estiver faltando no CSV, um erro será retornado.
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,
}
Gerando modelos com IA O
Immersive Fox oferece um recurso poderoso que automatiza a criação de modelos. Em vez de projetar manualmente cada modelo, você pode aproveitar nossos modelos de IA para gerá-los para você. Basta fornecer um prompt de texto descritivo e nossos algoritmos criarão um modelo abrangente que inclui cenas, texto, fundos e vozes. Nossa IA também utilizará os dados do arquivo CSV especificado durante a geração de vídeo em massa. Isso permite que você crie campanhas de marketing personalizadas para seus clientes sem esforço. Você pode especificar quais campos do CSV serão usados no vídeo, fornecendo o campo optional_params_for_scripts no payload. Use o seguinte comando curl para solicitar um modelo gerado 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,
}
Listing Template
Para listar todos os templates criados pelo usuário, use a seguinte solicitação de API. Ela retorna detalhes de todos os templates, permitindo que você os revise e gerencie. Depois de ter os templates, você pode usar o 'id' de qualquer um desses templates como 'template_id' em create bulk requests para gerar uma solicitação em massa usando este template.
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
}
]
Obter detalhes do modelo
Para obter detalhes de um modelo específico, use a seguinte solicitação de API. Ela fornece informações sobre o modelo selecionado, permitindo que você visualize as configurações antes da geração da solicitação em massa. Depois de obter os detalhes do modelo, você pode usar o 'id' como 'template_id' em criar solicitações em massa para gerar uma solicitação em massa usando este modelo.
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,
}