Skip to main content
POST
Render Storyboard Video

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.
Direct Render: Use this endpoint when you are confident in your content and want to skip the preview step, or when re-rendering a previously approved storyboard.

Render Workflow Options


Preview vs. Final Render


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

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

Request 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.
string
required
Name for your video project (alphanumeric, spaces, underscores, and hyphens only, max 150 characters)
integer
Width of the generated video in pixels. Must be provided together with videoHeight.
integer
Height of the generated video in pixels. Must be provided together with videoWidth.
string
Video aspect ratio. Options: 1:1, 16:9, 9:16, 4:5
string
Language 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 Tamil
boolean
Whether to save the project in your Pictory account for later editing. Default: false
string
URL where the completed video output will be sent via POST request when finished (max 500 characters)
object
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.
string
ID of a template to use. Get from Get Templates API.
object
Key-value object for template variables. Only applicable when templateId is provided.
string
ID of the brand to apply. Get from Get Video Brands API. Cannot be used with brandName.
string
Name of the brand to apply. Cannot be used with brandId.
string
Name of the smart layout to apply. Get available layouts from Get Smart Layouts API. Cannot be used with smartLayoutId.
string
ID of the smart layout to apply. Get from Get Smart Layouts API. Cannot be used with smartLayoutName.
string
Experimental: This field is currently experimental. In the future, all storyboards will automatically use the latest version, and this field will be ignored. There is no need to remove it from your requests when that happens.
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
string
ID of a saved text style for subtitles. Get from Get Text Styles API. Cannot be used with subtitleStyleName.
string
Name of a saved text style for subtitles. Cannot be used with subtitleStyleId.
object
Inline subtitle style configuration. See Create Storyboard Preview - subtitleStyle Object.
string
AWS connection ID for accessing private S3 assets. Get from Get AWS Connections API.
string
Vimeo connection ID for uploading videos directly to Vimeo. Get from Get Vimeo Connections API.
array
Array of destination configurations for uploading the generated video (max 5). See Create Storyboard Preview - destinations Array.
object
Voice-over configuration for AI narration. See Create Storyboard Preview - voiceOver Object.
object
Background music configuration for the video. See Create Storyboard Preview - backgroundMusic Object.
Logo overlay configuration. See Create Storyboard Preview - logo Object.
array
required
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.
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 Text to Video Render

Render with Full Configuration

Poll for Completion


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