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 5: GET Video Download URL

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 download link can be obtained from the response body once the job has successfully completed.
"videoURL": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/PictoryQAVidyard/fcc1f092-3e04-4828-acf6-75dbcffd6a6c/VIDEO/Santa Claus.mp4",
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 - Video Download URL - Video Download URL
{
    "job_id": "702f8260-c56a-4fbc-9741-ddc44df24aa2",
    "success": true,
    "data": {
        "preview": "production/users/<CUSTOMER-USER-ID>/projects/702f8260-c56a-4fbc-9741-ddc44df24aa2/702f8260-c56a-4fbc-9741-ddc44df24aa2_original.json",
        "txtFile": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/TEXT/subtitles/e5151b17-6328-4653-9154-8f8541f3c8c3.txt",
        "audioURL": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/AUDIO/testvideo.mp3",
        "thumbnail": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/IMAGE/thumbnails/5168e2eb-8588-4cd9-9c08-36c25cbbb028_testvideo.jpg",
        "videoDuration": 13.13,
        "videoURL": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/VIDEO/testvideo.mp4",
        "vttFile": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/TEXT/subtitles/9fae7224-d4eb-4fb6-9522-43f28326262b.vtt",
        "srtFile": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/TEXT/subtitles/c74ee662-7592-406e-87ab-cff02cf42b05.srt",
        "shareVideoURL": "https://d3uryq9bhgb5qr.cloudfront.net/EnterpriseSubscription/<CUSTOMER-USER-ID>/702f8260-c56a-4fbc-9741-ddc44df24aa2/VIDEO/testvideo.mp4",
        "status": "completed"
    }
}

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

🟢200Video Download URL
application/json
Body
job_id
string 
required
success
boolean 
required
data
object 
required
preview
string 
required
txtFile
string 
required
audioURL
string 
required
thumbnail
string 
required
videoDuration
number 
required
videoURL
string 
required
vttFile
string 
required
srtFile
string 
required
shareVideoURL
string 
required
status
string 
required
🟢200Render In Progress
Modified at 2024-07-10 08:41:40
Previous
Step 4: Render PUT
Next
Step 1: Authenticate
Built with