Request to render or create a batch of videos (one or more) from a template.
At most 200 rows per request (templateData); beyond that the call is rejected with a 400. Every generated video also carries the tag api, whether or not you send tags — which is the simplest way to find API-created videos later.
This endpoint accepts work, it does not complete it
A
200means the render was queued. Validation runs after the response is sent, so no render
failure can reach you as an HTTP status. Failures arrive as avideo_errorwebhook, or as
status: "error"onGET /videos/{videoId}if you poll.Messages you may receive that way:
Message Cause Slide N is too long. Please limit speech to Xs.Speech exceeds the global per-slide limit Slide N is too long for this avatar. Please limit speech to Xs.Speech exceeds this avatar's own limit, which is lower Slide N uses a premium avatar that is no longer available...The slide's premium avatar is not available to your plan You do not have enough minutes to render this video...No minutes left, and the workspace is not allowed to overrun Your video has N slides but your plan allows only 3 slides to render.Free plans render at most 3 slides Video with music should be minimum 2 seconds longBackground music on a video shorter than 2s If you cannot afford to miss a
video_error— deliveries are single-attempt, with no retry —
reconcile withGET /videosinstead of relying on the callback alone.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
How to create personalized videos
Check how to use this API call to create personalized videos here.
If templateData contains only single item, then the identifier of the newly created video will be returned immediately in response, and webhook "video_ready" will be triggered too.
{
"accepted": true,
"requestId": "FKdFTb5MciFRG1QD",
"videoId": "63ea63c1c00dfe1a72cc7426"
}
Otherwise, we will trigger a related webhook for each rendered video with related requestId and batchRowId, so you can map each videoId when it's ready to the data row in your request.
For example:
{
"event": "video_ready",
"requestId": "FKdFTb5MciFRG1QD",
"batchRowId": "0 - index of video in related batch request",
"video": {
"_id": "63ea63c1c00dfe1a72cc7426",
"other": "fields"
}
}