Render Video with Modifications
Videos
Render Video with Modifications
Render final video from modified storyboard elements returned in the preview response
POST
Render Video with Modifications
Documentation Index
Fetch the complete documentation index at: https://docs.pictory.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Render Video API generates a final video from storyboard elements that can be modified before rendering. This endpoint uses therenderParams 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.Render Workflow Options
| 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 |
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
API key for authentication
Must be
application/jsonRequest Body
The request body should contain the values from therenderParams 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 arenderParams object containing the complete storyboard configuration:
renderParams directly as the request body for this API:
Modifiable Elements
WithinrenderParams, 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 |
Element Types
| elementType | Description |
|---|---|
audioElement | Voice-over or background music audio |
backgroundElement | Scene background video or image |
SceneText | Subtitle/caption text overlay |
Response
When the render request is successfully submitted, a job is created and a job ID is returned.Indicates whether the request was successful
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 thejobId, 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
Basic Render with Modified Elements
Complete Workflow: Preview, Modify, Render
Example: Replace Scene Background
Error Handling
400 - Missing Required Fields
400 - Missing Required Fields
renderParams including output, elements, sceneMarkers, and projectId. Send the renderParams content directly as the request body.400 - Invalid Request Structure
400 - Invalid Request Structure
renderParams. Only modify specific properties, do not remove required fields.400 - Invalid Element Configuration
400 - Invalid Element Configuration
id, elementType, and type properties.401 - Unauthorized
401 - Unauthorized
Related APIs
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
