Videos (mp4) can be created by sending data and customisation parameters to the POST /async/banner-builder/{template_id}/generate endpoint (with the image_file_type property equals to mp4), which will respond synchronously with only a generation_request_id property.
Once the generation is completed, the result will then be posted to the callback_url (webhooks system).
Supported template type: Animated
Generation response type: Asynchronous (Webhooks or Polling)
Generation Request (1st & 2nd)
Ensure the image_file_type parameter has the value mp4.
In addition to the supported image properties, a video property can be sent through the Abyssale REST API call to customise the output video. Here is the available option:
fps: Number of frames per second. Default value is 24
Min: 2
Max: 25
"video": {
"fps": 24
},
Input videos
Videos can be added to your template & then can be customised via the video_url property:
The video_url only accepts mp4, webm or mov video public URLs.
The maximum file size is 100Mo per video
The video can be trimmed using the following query properties to the video url:
trim_start: Start of the video in seconds. i.e: ?trim_start=2.5 to start your video at 2.5s
trim_end: End of the video in seconds. i.e: ?trim_end=10 to end your video at 10s
The generated video extension is mp4.
The sound can be muted by using the property audio_muted and set it to 1
File compression level
You can optionally set the file_compression_level. The "File Compression Level" option allows you to fine-tune the balance between file size and quality when processing files. You can choose a value between 1 and 100, where 1 represents the highest compression for the smallest file size (lower quality), and 100 signifies the best quality with larger file sizes. The default value is 100.
"file_compression_level": 100
Sample request
Do not forget to replace {YOUR-API-KEY} and {templateId}
The generation response can be obtained either by polling the API or by receiving the response directly to a callback_url that was announced during the generation request. Either way the payload of the response will look like the NEW_BANNER_BATCH event.
