Render final video from modified storyboard elements returned in the preview response
renderParams property returned from a completed Create Storyboard Preview job, allowing you to make changes to scenes, visuals, text, and other elements before producing the final video.
renderParams object from a completed preview job. First create a preview, retrieve the job output to get renderParams, modify as needed, then submit to this endpoint.| Workflow | API | When to Use |
|---|---|---|
| Create Preview | Create Storyboard Preview | Generate preview to review scenes before rendering |
| Render from Preview | Render from Preview | Render preview as-is without modifications |
| Render with Modifications | This API | Modify preview elements before rendering |
| Render Saved Project | Render Project | Render existing project created in App or via API |
| Direct Render | Render Storyboard Video | Skip preview, render directly from input |
application/jsonrenderParams object returned in a completed preview job response. Send the renderParams content directly as the request body (not wrapped in a renderParams property). You can modify any properties before submitting.
renderParams object containing the complete storyboard configuration:
renderParams directly as the request body for this API:
renderParams, you can modify:
| Element | Description |
|---|---|
output | Video output settings (width, height, format, name, title) |
elements | Array of all video elements - audio, backgrounds, and text |
elements[].url | Change background video/image URL for backgroundElement types |
elements[].text | Update subtitle text for SceneText elements |
elements[].duration | Adjust element timing |
elements[].fontFamily, fontSize, fontColor | Modify text styling |
sceneMarkers | Scene timing and markers |
subtitles | Subtitle text content |
| elementType | Description |
|---|---|
audioElement | Voice-over or background music audio |
backgroundElement | Scene background video or image |
SceneText | Subtitle/caption text overlay |
pending - Job is queuedin-progress - Video is being renderedcompleted - Video is ready with videoURL in the responsefailed - Rendering failed with error details400 - Missing Required Fields
renderParams including output, elements, sceneMarkers, and projectId. Send the renderParams content directly as the request body.400 - Invalid Request Structure
renderParams. Only modify specific properties, don’t remove required fields.400 - Invalid Element Configuration
id, elementType, and type properties.401 - Unauthorized