Render Storyboard Video

post

https://api.pictory.ai/pictoryapis/v2/video/storyboard/render

This API helps you turn your written content—like blog articles, text stories, presentations (PPTs), or even audio recordings—into engaging videos. It automatically finds the most relevant visuals, adds background music, and lets you include voice-overs (AI-generated or your own recordings). You can also customize how subtitles appear in the final video, making it a quick and easy way to bring your content to life.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Main request object for text-to-video generation

awsConnectionId

string

length ≤ 500

AWS connection identifier for connecting to private s3 assets

vimeoConnectionId

string

length ≤ 500

Vimeo connection identifier for uploading videos directly to Vimeo

destinations

array

length ≤ 5

List of destinations where the generated video should be uploaded (e.g., Vimeo, S3)

destinations

templateId

string

The ID of a template previously created using the "Create Template API." Use this to generate a video based on a specific template or to apply its visual style and structure.

brandId

string

The ID of the brand you want to apply to the video. This ID must correspond to a brand created in the Pictory App and can be retrieved using the "Get Video Brands" API under the BRANDING-VIDEO category.

brandName

string

The name of the brand to be applied to the video. You can obtain this from the "Get Video Brands" API under the BRANDING-VIDEO category or copy it directly from the Brands page in the Pictory App.

variables

object

A key-value object containing data for template variables. Each key should match the name of a variable defined in the selected template. This property is only applicable when a valid templateId is provided. If templateId is not specified, variables should not be included.

webhook

string

length ≤ 500

A URL where the completed storyboard output will be sent via a POST request once the storyboard generation job is finished. This allows your system to receive the result automatically.

videoName

string

required

length ≤ 150

^[a-zA-Z0-9 _-]+$

Name for the generated video (alphanumeric, spaces, underscores, and hyphens only)

videoWidth

integer

Width of the generated video in pixels (must be provided with videoHeight)

videoHeight

integer

Height of the generated video in pixels (must be provided with videoWidth)

saveProject

boolean

Whether to save the project for future editing in your Pictory App account. This is applicable only if your API credentials are linked to a Pictory App account.

language

string

enum

Language of the text content or AI voice-over

backgroundMusic

object

Background music configuration for the video

voiceOver

object

Voice-over configuration for the video

logo

object

Logo overlay configuration

subtitleStyle

object

Font styling configuration for text elements

subtitleStyleId

string

The ID of the text style to be used for subtitles in the video. This ID should match one of the text styles defined in the Pictory App and can be retrieved using the "Get Text Styles" API under the BRANDING-VIDEO category.

subtitleStyleName

string

The name of the text style to be applied to subtitles in the video. You can obtain this from the "Get Text Styles" API under the BRANDING-VIDEO category or copy it from the Text Styles section in the Pictory App. If subtitleStyleId is provided, this property will be ignored.

scenes

array of objects

required

Array of scenes that make up the video

scenes*

Headers

Authorization

string

required

This header is used to authenticate API requests using an access token obtained from the OAuth token API.

Responses

200Storyboard job created successfully

400Invalid request

401Unauthorized

500Internal server error