Pictory
  1. Text to Video API Flow
Pictory
  • API Flows
    • Text to Video API Flow
      • Step 1: Authenticate
        POST
      • Step 2: Generate Video Preview from Text
        POST
      • Step 3: GET Video Preview & Default Settings
        GET
      • Step 4: Render Video
        POST
      • Step 4: Render PUT
        PUT
      • Step 5: GET Video Download URL
        GET
    • Video Editing API Flow
      • Step 1: Authenticate
      • Step 2: Obtain Pictory Upload URL
      • Step 3: Upload video to Pictory
      • Step 4: v2 Transcribe Uploaded Video
      • Step 5: GET Default Transcription & Highlights Settings
      • Step 6: Render Video
      • Step 7: GET Video Download URL
    • Bulk Video Generation APIs
      • Step 1: Authenticate
      • Step2: Upload Project
      • Step3: Update Variables
      • Step 4: Get Video Preview
      • Step 5: Render Video
      • Step 6: GET Video Download URL
  • API Reference
    • /v1/oauth2/token
      POST
    • /v1/video/storyboard
      POST
    • /v1/job/{job_id}
      GET
    • /v1/media/generateUrl
      POST
    • Upload video to Pictory
      PUT
    • /v2/transcription (Transcript & Highlights)
      POST
    • /v2 GET Default Transcription & Highlights Settings
      GET
    • /v1/transcription
      POST
    • /v1 GET Default Transcription Settings
      GET
    • /v1/transcription/highlights
      POST
    • /v2/transcription/highlights
      POST
    • /v1 GET Default Highlight Settings
      GET
    • /v1/video/storyboard/fonts
      GET
    • Create Template
      POST
    • Update Template
      PUT
    • Get Templates
      GET
    • Create Template Video
      POST
    • Get Template By Id
      GET
    • Delete Template By Id
      DELETE
    • /v1/video/render
      POST
    • v1/media/search
      GET
  1. Text to Video API Flow

Step 3: GET Video Preview & Default Settings

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
GET
/v1/jobs/{{job_id}}
The response depends on job status. View variations by selecting a response from the Example Response section's top-right dropdown.
The video preview link can be obtained from the response body of once the job has successfully completed, the link is at the bottom of the json body.
"preview": "https://feature-share-preview.d1tv7y7t27ylrr.amplifyapp.com/preview/5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
Default video settings data is contained in the renderParams response body object. This data is auto-captured in the Postman environment.
To view the capture method see API call Tests.
To view the stored data in the Postman environment, see values: audio_settings, output_settings, scene_settings.
Initial pending response
{
    "job_id": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb",
    "success": true,
    "data": {
        "status": "in-progress"
    }
}
Completed job response
{
    "success": true,
    "data": {
        "renderParams": {
            "audio": {
                "video_volume": 1,
                "tts": "https://pictory-audios.s3.us-east-2.amazonaws.com/polly/production/projects/PictoryQAVidyard/f54362ae02de425cb0dc83a75271b5e0.mp3"
            },
            "output": {
                "name": "Santa Claus.mp4",
                "description": "Santa Claus is coming to town",
                "format": "mp4",
                "title": "Santa Claus",
                "height": 1080,
                "width": 1920
            },
            "scenes": [
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/HJDS012pYkysh5h0a/videoblocks-176z_winter_021219_5_sbbt1bfmgn__3a36a68d6a9e04708f8b9307bfe5f751__P480.mp4?type=preview&origin=VIDEOBLOCKSĂ—tamp_ms=1686596540699&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=347545181&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=d63d38e0-49b1-4726-bcf4-f9684fd7a0d1&searchPageId=a3e87291-674a-4de9-afc1-d14b1e7462e8",
                                "asset_id": 347545181,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 347545181,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 7.368,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 7.368,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "In the North Pole, beneath the shimmering stars, Santa Claus, with a merry twinkle in his eyes,",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "gears up for his Christmas ride.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 1",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "In the North Pole, beneath the shimmering stars, Santa Claus, with a merry twinkle in his eyes, gears up for his Christmas ride.",
                            "time": 7.368
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/SyjJvDm-2lfvizvfc/videoblocks-646ad3b8cdf8cd05c418a542_rie43pwu3__5a630c977a8f89ce33c752fbf7a198f8__P480.mp4?type=preview&origin=VIDEOBLOCKSĂ—tamp_ms=1688006838928&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=347682088&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=95e9abea-3fb6-479b-ad0a-065cc5945aec&searchPageId=7888e0a8-4e90-4f45-8f2e-3efded1472e4",
                                "asset_id": 347682088,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 347682088,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 7.104,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 7.104,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "His workshop buzzes as elves craft toys, while Santa, in his festive red suit, checks his list of",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "children worldwide.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 2",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "His workshop buzzes as elves craft toys, while Santa, in his festive red suit, checks his list of children worldwide.",
                            "time": 7.104
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/NdHffr7_eijh7icah/videoblocks-lighted-santa-clauss-reindeer-against-christmas-tree_hhfzr9vdx7__56c4b8a75a63dff250c338e216a075b9__P480.mp4?type=preview&origin=VIDEOBLOCKSĂ—tamp_ms=1686183110424&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=7152947&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=f921bb54-7a42-46a4-a8fb-520ceb1ce006&searchPageId=70cbab1c-7a5d-4dd7-b5e2-a0325d04a7a9",
                                "asset_id": 7152947,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 7152947,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 10.584,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 10.584,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "< strong> Come Christmas Eve</strong >, Santa and his reindeer, guided by Rudolph&#x27;s bright",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "nose whisk through the sky with Santa's sleigh brimming with gifts.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 3",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "< strong> Come Christmas Eve</strong >, Santa and his reindeer, guided by Rudolph&#x27;s bright nose whisk through the sky with Santa&#x27;s sleigh brimming with gifts.",
                            "time": 10.584
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/YZiMuLM/videoblocks-santa-eating-cookies_rxbjxr7b__e1ef0b916473ed05dd57a32f593684ed__P480.mp4?type=preview&origin=VIDEOBLOCKSĂ—tamp_ms=1686158755553&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=4350303&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=9f8c79d4-efff-4c9e-b0db-b21cfdb57add&searchPageId=fdcbdcd7-1d1d-4500-9f13-8d6a07232e8b",
                                "asset_id": 4350303,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 4350303,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 5.64,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 5.64,
                            "location": {
                                "start_x": 50,
                                "start_y": 985.808
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "At every stop, Santa descends chimneys, leaves presents, and heartily nibbles on cookies.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 4",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "At every stop, Santa descends chimneys, leaves presents, and heartily nibbles on cookies.",
                            "time": 5.64
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/G7kazyU/videoblocks-christmas-time-in-home_hidyydgwm__0269ec08d36c07115c5511b1c1cdc40d__P480.mp4?type=preview&origin=VIDEOBLOCKSĂ—tamp_ms=1687370079097&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=7563746&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=a7464d34-29ad-47f6-ba2a-965b5b476aa6&searchPageId=c733fe17-aa8e-4c59-93b7-a0f6daa39b40",
                                "asset_id": 7563746,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 7563746,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 6.672,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 6.672,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "With the break of dawn, Santa returns home leaving behind a world infused with Christmas",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "magic and love.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 5",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "With the break of dawn, Santa returns home leaving behind a world infused with Christmas magic and love.",
                            "time": 6.672
                        }
                    ]
                }
            ],
            "next_generation_video": true,
            "containsTextToImage": true
        },
        "preview": "https://feature-share-preview.d1tv7y7t27ylrr.amplifyapp.com/preview/5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
    },
    "job_id": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://dev.your-api-server.com/v1/jobs/{{job_id}}' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}'
Response Response Example
200 - Default Video Settings - Default Video Settings
{
    "success": true,
    "data": {
        "renderParams": {
            "audio": {
                "video_volume": 1,
                "tts": "https://pictory-audios.s3.us-east-2.amazonaws.com/polly/production/projects/<PROJECTNAME>/f54362ae02de425cb0dc83a75271b5e0.mp3"
            },
            "output": {
                "name": "Santa Claus.mp4",
                "description": "Santa Claus is coming to town",
                "format": "mp4",
                "title": "Santa Claus",
                "height": 1080,
                "width": 1920
            },
            "scenes": [
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/HJDS012pYkysh5h0a/videoblocks-176z_winter_021219_5_sbbt1bfmgn__3a36a68d6a9e04708f8b9307bfe5f751__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1686596540699&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=347545181&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=d63d38e0-49b1-4726-bcf4-f9684fd7a0d1&searchPageId=a3e87291-674a-4de9-afc1-d14b1e7462e8",
                                "asset_id": 347545181,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 347545181,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 7.368,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 7.368,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "In the North Pole, beneath the shimmering stars, Santa Claus, with a merry twinkle in his eyes,",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "gears up for his Christmas ride.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 1",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "In the North Pole, beneath the shimmering stars, Santa Claus, with a merry twinkle in his eyes, gears up for his Christmas ride.",
                            "time": 7.368
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/SyjJvDm-2lfvizvfc/videoblocks-646ad3b8cdf8cd05c418a542_rie43pwu3__5a630c977a8f89ce33c752fbf7a198f8__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1688006838928&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=347682088&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=95e9abea-3fb6-479b-ad0a-065cc5945aec&searchPageId=7888e0a8-4e90-4f45-8f2e-3efded1472e4",
                                "asset_id": 347682088,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 347682088,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 7.104,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 7.104,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "His workshop buzzes as elves craft toys, while Santa, in his festive red suit, checks his list of",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "children worldwide.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 2",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "His workshop buzzes as elves craft toys, while Santa, in his festive red suit, checks his list of children worldwide.",
                            "time": 7.104
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/NdHffr7_eijh7icah/videoblocks-lighted-santa-clauss-reindeer-against-christmas-tree_hhfzr9vdx7__56c4b8a75a63dff250c338e216a075b9__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1686183110424&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=7152947&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=f921bb54-7a42-46a4-a8fb-520ceb1ce006&searchPageId=70cbab1c-7a5d-4dd7-b5e2-a0325d04a7a9",
                                "asset_id": 7152947,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 7152947,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 10.584,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 10.584,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "< strong> Come Christmas Eve</strong >, Santa and his reindeer, guided by Rudolph's bright",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "nose whisk through the sky with Santa's sleigh brimming with gifts.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 3",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "< strong> Come Christmas Eve</strong >, Santa and his reindeer, guided by Rudolph's bright nose whisk through the sky with Santa's sleigh brimming with gifts.",
                            "time": 10.584
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/YZiMuLM/videoblocks-santa-eating-cookies_rxbjxr7b__e1ef0b916473ed05dd57a32f593684ed__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1686158755553&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=4350303&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=9f8c79d4-efff-4c9e-b0db-b21cfdb57add&searchPageId=fdcbdcd7-1d1d-4500-9f13-8d6a07232e8b",
                                "asset_id": 4350303,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 4350303,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 5.64,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 5.64,
                            "location": {
                                "start_x": 50,
                                "start_y": 985.808
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "At every stop, Santa descends chimneys, leaves presents, and heartily nibbles on cookies.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 4",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "At every stop, Santa descends chimneys, leaves presents, and heartily nibbles on cookies.",
                            "time": 5.64
                        }
                    ]
                },
                {
                    "background": {
                        "src": [
                            {
                                "url": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/G7kazyU/videoblocks-christmas-time-in-home_hidyydgwm__0269ec08d36c07115c5511b1c1cdc40d__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1687370079097&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=7563746&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=a7464d34-29ad-47f6-ba2a-965b5b476aa6&searchPageId=c733fe17-aa8e-4c59-93b7-a0f6daa39b40",
                                "asset_id": 7563746,
                                "type": "video",
                                "library": "story_blocks",
                                "mode": "fit",
                                "frame": null,
                                "loop_video": true,
                                "mute": true,
                                "resource_id": 7563746,
                                "sessionId": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
                            }
                        ],
                        "color": "rgba(255,255,255,255)",
                        "bg_animation": {
                            "animation": "pan-right"
                        }
                    },
                    "time": 6.672,
                    "keywords": [],
                    "sub_scenes": [
                        {
                            "time": 6.672,
                            "location": {
                                "start_x": 50,
                                "start_y": 929.28
                            },
                            "displayItems": [],
                            "text_lines": [
                                {
                                    "text": "With the break of dawn, Santa returns home leaving behind a world infused with Christmas",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                },
                                {
                                    "text": "magic and love.",
                                    "text_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ],
                                    "text_bg_animation": [
                                        {
                                            "animation": "slide-in-left",
                                            "source": "templates",
                                            "speed": 1.4,
                                            "type": "start"
                                        },
                                        {
                                            "animation": "none",
                                            "source": "templates",
                                            "speed": 0.5,
                                            "type": "end"
                                        }
                                    ]
                                }
                            ],
                            "subtitle": "",
                            "showSceneNumber": "Scene 5",
                            "font": {
                                "name": "Arial.ttf",
                                "size": 32,
                                "line_spacing": 1.2,
                                "color": "rgba(255,255,255,255)",
                                "backcolor": "rgba(17,17,17,153)",
                                "keycolor": "rgba(226,226,170,255)",
                                "textShadowColor": "rgba(255,255,255,1)",
                                "textShadowWidthFr": 0,
                                "line_height": 55.328,
                                "case": null,
                                "decoration": [],
                                "fullWidth": false
                            }
                        }
                    ],
                    "music": false,
                    "tts": true,
                    "subtitle": true,
                    "subtitles": [
                        {
                            "text": "With the break of dawn, Santa returns home leaving behind a world infused with Christmas magic and love.",
                            "time": 6.672
                        }
                    ]
                }
            ],
            "next_generation_video": true,
            "containsTextToImage": true
        },
        "preview": "https://feature-share-preview.d1tv7y7t27ylrr.amplifyapp.com/preview/5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
    },
    "job_id": "5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
}

Request

Header Params
Authorization
string 
required
Example:
{{access_token}}
X-Pictory-User-Id
string 
required
Used for logging purposes
Example:
{{X-Pictory-User-Id}}

Responses

🟢200Default Video Settings
application/json
Body
success
boolean 
required
data
object 
required
renderParams
object 
required
preview
string 
required
job_id
string 
required
🟢200Preview In Progress
Modified at 2024-07-10 08:41:40
Previous
Step 2: Generate Video Preview from Text
Next
Step 4: Render Video
Built with