Generate video from template

Request Body

FieldTypeDescription
template_idstringUnique identifier for the template video.
testboolSet the test flag to true to use test mode. Generation in test mode will not cost your credits and will contain a watermark on your video.
titlestringOptional, Your video title.
caption_openboolSet it true to create video with caption.
variablesList of variables you want to replace.
variables[].namestringThe name of the variables.
variables[].propertiesObjectProperties of the variables you want to replace.

Response

FieldTypeDescription
id
stringUnique identifier for the object.
errorjsonOptional, the error detail of the video.
statusstringVideo status, one of
- processing (The video is rendering)
- completed (The video render success)
- failed (An error occurred when rendering video).

Tools

You may use this web tool to find out the variable name for your video template.

Language
Authorization
Header
Click Try It! to start a request and see the response here!