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 4: Render PUT

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
PUT
/v1/video/render/{{job_id}}
This call Renders the video for download.
The video download link can be obtained from the GET Video Download URL call response body once the job has successfully completed.
"videoURL": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/PictoryQAVidyard/702f8260-c56a-4fbc-9741-ddc44df24aa2/VIDEO/testvideo.mp4"
Default video settings data is obtained from the renderParams response body object of the GET Video Preview & Default Settings API call. 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.
For custom settings, manually replace request body with renderParams data.
Refer to Pictory Web App Storyboard for all setting values.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://dev.your-api-server.com/v1/video/render/{{job_id}}' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    //"webhook": ""
}'
Response Response Example
{
    "data": {
        "job_id": "fcc1f092-3e04-4828-acf6-75dbcffd6a6c"
    },
    "success": true
}

Request

Header Params
Authorization
string 
required
Example:
{{access_token}}
X-Pictory-User-Id
string 
required
Used for logging purposes
Example:
{{X-Pictory-User-Id}}
Body Params application/json
object {0}
Examples

Responses

🟢200Step 4: Render Video
application/json
Body
data
object 
required
job_id
string 
required
success
boolean 
required
Modified at 2024-07-10 08:41:40
Previous
Step 4: Render Video
Next
Step 5: GET Video Download URL
Built with