Skip to content

Bulk Video Request using Template

This API guide provides an overview of bulk request generation using templates.

Templates simplify the process of generating bulk requests. To reduce the need for repetitive data entry when creating videos, you can create a template using the create template API. Once established, you can use this template multiple times to efficiently generate bulk requests. To know about what is a bulk request read create bulk request API introduction 🦊

Quick Start

Let’s dive in and explore how to create a bulk request using a bulk template.

Creating Bulk Request from Template

You can use the 'id' as 'template_id' obtained from either the template listing API or create template API. Provide this 'template_id' along with the "video_name" to create a bulk request. In the response, you will receive details on the number of successful videos and any that have failed. Use the 'id' from the response to check the status of the bulk request using bulk status API

The configurations are optional, If you send any configuration than it will be updated in the template and the videos will be generated according to the new template. Note that if you provide the configurations, you must also specify the scene_number field.

  • 'id': The identifier for the bulk request.
  • 'successful_requests_count': The number of videos successfully sent for processing.
  • 'failed_requests_count': The number of videos that failed to go for processing.
curl --request POST  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/generate_video_from_template/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'  \
     --data { \
                "template_id": 45, \
                "csv_id": 123, \
                "configurations": [ \
                    { \
                        "scene_number": 1, \
                        "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_transition": "none", \
                        "audio_id": 2, \
                        "audio_service": "google_audio", \
                        "user_voice_speed": 1, \
                        "x_position": 0.604931, \
                        "y_position": 0.43101 \
                    } \
                ] \
            }

{
    "id": 108,
    "message": "Requests Created",
    "successful_requests_count": 3,
    "failed_requests_count": 0,
    "failed_requests": []
}