Render Storyboard Output

post https://api.pictory.ai/pictoryapis/v1/video/render

This API requests Pictory Server to generate downloadable video link. This is asynchronous REST API.

Request Header

Parameter Name	Parameter Type	Description
Authorization	String (Required)	An authorization Token is required to call the Storyboard API. Authentication API. Contact support@pictory.ai to get access to the Authentication API.
X-Pictory-Customer-Id	String (Required)	You can obtain X-Pictory-Customer-Id by reaching out to us at support@pictory.ai

Request Object

Video rending is a complex process and so is the request body of this API. If you want to generate Video from text or edit an existing video, renderParams object from the Storyboard API Job Response can be the request body for video rendering.

Tips: Call Storyboard API to get the Request Object for this API. Use the data within renderParams object from Storyboard API callback as Request body of Render API

Response

The Video download link and other details are sent to the webhook URL sent in the request object.

You can check the video rendering status from GET Job API . Once the job has been completed, this API also returns The video download link) in the response body once the job has successfully completed.

Responses

Language


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://api.pictory.ai/pictoryapis/v1/video/render \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "audio": {
8
    "audio_library": "track",
9
    "track_volume": 0.5
10
  },
11
  "output": {
12
    "description": "Description of Video File",
13
    "format": "mp4"
14
  },
15
  "next_generation_video": true,
16
  "containsTextToImage": true
17
}
18
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Request Header

Request Object

Response

200200

400400