Skip to main content
POST
Render Video with Modifications

Overview

The Render Video API generates a final video from storyboard elements that can be modified before rendering. This endpoint uses the 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.
This endpoint requires the 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.
Use this endpoint when you need to modify the preview - change scenes, update visuals, adjust timing, or customize content before final render.

Render Workflow Options

When to Use This Endpoint

Scene Modifications

Add, remove, or reorder scenes from the preview

Visual Replacements

Replace AI-selected backgrounds with custom visuals

Text Updates

Modify subtitle text or scene content

Timing Adjustments

Change scene durations or transitions

API Endpoint


Request Parameters

Headers

string
required
API key for authentication
string
required
Must be application/json

Request Body

The request body should contain the values from the renderParams 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.

Getting renderParams from Preview Job

After creating a storyboard preview, retrieve the job output using the Get Storyboard Preview Job by ID API. The response includes a renderParams object containing the complete storyboard configuration:
Use the contents of renderParams directly as the request body for this API:

Modifiable Elements

Within renderParams, you can modify:

Element Types


Response

When the render request is successfully submitted, a job is created and a job ID is returned.
boolean
Indicates whether the request was successful
object
string
Unique identifier for the render job. Use this to track the job status and retrieve results via the Get Video Render Job by ID endpoint.

Next Steps

Once you have the jobId, poll the Get Video Render Job by ID endpoint to check the render status and retrieve the output URLs when complete. Use a polling interval of 10–30 seconds.

Code Examples

Replace YOUR_API_KEY with your actual API key.

Basic Render with Modified Elements

Complete Workflow: Preview, Modify, Render

Example: Replace Scene Background


Error Handling

Solution: Ensure your request body contains all required fields from the preview job’s renderParams including output, elements, sceneMarkers, and projectId. Send the renderParams content directly as the request body.
Solution: Ensure the request body maintains the required structure from the preview job’s renderParams. Only modify specific properties, do not remove required fields.
Solution: Check that modified elements have valid configurations. Ensure URLs are accessible and properly formatted. Each element must have valid id, elementType, and type properties.
Solution: Check your API key is valid and correctly formatted in the Authorization header.

Create Storyboard Preview

Generate preview to get renderParams (Step 1)

Render from Preview

Render preview as-is without modifications

Get Render Job Status

Monitor rendering progress

Search Media

Find replacement visuals for scenes