Custom Templates
Create Custom Template Video
API that generates video of custom template. Generating video through this endpoint costs 5 credits for every 30 seconds.
POST
About Request Data Structure of Webhook
When using ‘custom_templates’ API, if the ‘webhook_url’ is passed in the parameters, we will initiate a POST request to the webhook_url
when the task succeeds or fails, with the following content:
Arguments:
id
(string): The unique identifier of the jobstatus
(string): The status of the job. Possible values arepending
,in_queue
,running
,failed
,done
failed_reason
(string): The reason of the failure if the job failedvideo_output
(string): The URL of the video if the job is done
Note: We might send multiple requests for status changes.
Authorizations
API ID, from your settings page.
API Key, from your settings page.
Body
Maximum length:
256
Name of the video. Default is null.
Maximum length:
255
Webhook URL for status updates. Default is null.
Maximum length:
200
Response
200 - application/json
Failed reason
Credits used in this api call
pending
- Pendingin_queue
- In Queuerunning
- Runningfailed
- Faileddone
- Donerejected
- Rejected
Available options:
pending
, in_queue
, running
, failed
, done
, rejected
Maximum length:
256
Name of the video. Default is null.
Maximum length:
255
Webhook URL for status updates. Default is null.
Maximum length:
200