Render Storyboard Video
Videos
Render Storyboard Video
Render a final video from a storyboard with all scenes, visuals, voice-over, and effects
POST
Render Storyboard Video
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 Storyboard Video API generates the final rendered video file from your storyboard configuration. This endpoint processes all scenes, applies voice-over narration, background music, visual effects, and produces a complete video ready for distribution.This endpoint renders the final video directly. For a preview-first workflow, use the Create Storyboard Preview API to review scenes before rendering.
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 | Render Video | Modify preview elements before rendering |
| Render Saved Project | Render Project | Render existing project created in App or via API |
| Direct Render | This API | Skip preview, render directly from input |
Preview vs. Final Render
| Aspect | Storyboard Preview | Final Render |
|---|---|---|
| Purpose | Review and validate content | Produce final video file |
| Output | Scene thumbnails, metadata, project structure | Full HD video file |
| Speed | Fast | Slower |
| Cost | Lower resource usage | Full rendering resources |
| Editable | Yes, make changes before render | Video is final |
| Use Case | Content approval, iteration | Final delivery |
Use Cases
Direct Video Creation
Generate final videos directly from text, articles, or presentations
Batch Rendering
Render multiple videos programmatically at scale
Automated Pipelines
Integrate into automated content creation workflows
Re-rendering
Re-render videos after making adjustments to projects
Template-based Videos
Generate videos from templates with variable content
Multi-platform Content
Create videos for different platforms with aspect ratios
API Endpoint
Request Headers
API key for authentication
Must be
application/jsonRequest Body Parameters
The request body accepts the same parameters as the Create Storyboard Preview API. All parameters for video configuration, scenes, voice-over, background music, branding, and destinations are supported.Name for your video project (alphanumeric, spaces, underscores, and hyphens only, max 150 characters)
Width of the generated video in pixels. Must be provided together with
videoHeight.Height of the generated video in pixels. Must be provided together with
videoWidth.Video aspect ratio. Options:
1:1, 16:9, 9:16, 4:5Language of the text content.Allowed values:
zh, nl, en, fr, de, hi, it, ja, ko, mr, pt, ru, es, tazh Chinese, nl Dutch, en English, fr French, de German, hi Hindi, it Italian, ja Japanese, ko Korean, mr Marathi, pt Portuguese, ru Russian, es Spanish, ta TamilWhether to save the project in your Pictory account for later editing. Default:
falseURL where the completed video output will be sent via POST request when finished (max 500 characters)
Custom data object that will be included in the webhook POST payload when the job completes. Use this to pass through any metadata (e.g., internal IDs, tracking info) that you need in your webhook handler.
ID of a template to use. Get from Get Templates API.
Key-value object for template variables. Only applicable when
templateId is provided.ID of the brand to apply. Get from Get Video Brands API. Cannot be used with
brandName.Name of the brand to apply. Cannot be used with
brandId.Name of the smart layout to apply. Get available layouts from Get Smart Layouts API. Cannot be used with
smartLayoutId.ID of the smart layout to apply. Get from Get Smart Layouts API. Cannot be used with
smartLayoutName.Specifies which storyboard version to use. Set to
v3 to create a latest Pictory storyboard. Omit this field to use the classic storyboard.Options:v3— Uses the latest Pictory storyboard- Omit or any other value — Uses the classic/legacy storyboard
ID of a saved text style for subtitles. Get from Get Text Styles API. Cannot be used with
subtitleStyleName.Name of a saved text style for subtitles. Cannot be used with
subtitleStyleId.Inline subtitle style configuration. See Create Storyboard Preview - subtitleStyle Object.
AWS connection ID for accessing private S3 assets. Get from Get AWS Connections API.
Vimeo connection ID for uploading videos directly to Vimeo. Get from Get Vimeo Connections API.
Array of destination configurations for uploading the generated video (max 5). See Create Storyboard Preview - destinations Array.
Voice-over configuration for AI narration. See Create Storyboard Preview - voiceOver Object.
Background music configuration for the video. See Create Storyboard Preview - backgroundMusic Object.
Logo overlay configuration. See Create Storyboard Preview - logo Object.
Array of scene objects containing the content to convert into video. Required unless using
templateId. See Create Storyboard Preview - scenes Array.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 Text to Video Render
Render with Full Configuration
Poll for Completion
Related APIs
Create Storyboard Preview
Preview storyboard before rendering
Get Render Job Status
Monitor rendering progress
Get Projects
List saved video projects
Get Voiceover Tracks
List available AI voices
