Videos

Render Storyboard Video

Changed on

Renders the final video file directly from a storyboard configuration, skipping the preview step. Accepts the same request body as Create Storyboard Preview. Returns a jobId that can be polled at the Get Video Render Job endpoint.

post/pictoryapis/v2/video/storyboard/render

Request

  • Base URL
    https://api.pictory.ai
  • Auth
    API key in header Authorization

Request body

videoNamestring required

Name for the video project. Allowed characters: alphanumeric, spaces, underscores, hyphens. Optional when aiStoryboard is enabled with a brief scene: if omitted, the AI-generated title is used.

videoWidthinteger

Video width in pixels. Must be supplied together with videoHeight.

videoHeightinteger

Video height in pixels. Must be supplied together with videoWidth.

aspectRatio'1:1' | '16:9' | '9:16' | '4:5'

Video aspect ratio.

language'zh' | 'nl' | 'en' | 'fr' | 'de' | 'hi' | 'it' | 'ja' | 'ko' | 'mr' | 'pt' | 'ru' | 'es' | 'ta'

Language of the text content.

saveProjectboolean

Whether to save the project for later editing.

webhookstring uri

URL to POST the job result to when finished.

webhookInputobject

Custom data echoed back in the webhook payload.

templateIdstring

Template ID. Obtain from Get Templates API.

variablesobject

Key/value pairs for template variables. Only valid with templateId.

brandIdstring

Brand ID to apply. Mutually exclusive with brandName.

brandNamestring

Brand name to apply. Mutually exclusive with brandId.

smartLayoutIdstring

Smart layout ID. Mutually exclusive with smartLayoutName.

smartLayoutNamestring

Smart layout name. Mutually exclusive with smartLayoutId.

storyboardVersion'v3'

Experimental. Set to v3 to use the latest Pictory storyboard. Omit for classic storyboard.

subtitleStyleIdstring

Saved text style ID for subtitles. Mutually exclusive with subtitleStyleName.

subtitleStyleNamestring

Saved text style name for subtitles. Mutually exclusive with subtitleStyleId.

awsConnectionIdstring

AWS connection ID for private S3 assets.

vimeoConnectionIdstring

Vimeo connection ID for direct Vimeo uploads.

payloadUrlstring

Optional URL to fetch a payload (backend-supported field).

projectMetadataobject

Arbitrary metadata stored with the saved project.

Response

Render job successfully created

successboolean

Indicates whether the request was successful

Changes

    • breaking

      removed the enum value veo3.1_fast of the request property ////

    • breaking

      removed the enum value veo3.1_fast of the request property /////////

    • breaking

      removed the enum value veo3.1_fast of the request property /////

    16 more changes in this revision