Video generation is a time-consuming process and thus most of our APIs are asynchronous. The Pictory server creates background jobs for use cases like generating video previews, rendering videos, etc. Many of our API call returns the job_id which can be used to check the status of the background action requested.

You can request different Pictory Jobs mentioned below:

  1. Video Preview Generation Job: Pictory allows you to generate a preview of the video before rendering the final video. This enables users to customize the sections of view they don't like. Video Preview Request can be made by calling Storyboard API. Storyboard API returns JobId in response.

    1. This API returns job_id in response that can be used to check job status using GET Job REST API.
    2. Once the job is complete, it gives a video preview URL and renderParams in the response.
  2. Video Generation/Rendering Job.: Video can be generated by passing the renderParams received in generate preview response as request object in Video Render API.

    1. This API too returns job_id in response. The job status can be seen by calling GET Job REST API.
    2. Once this job is complete, GET Job returns the response with a link to the video in .mp4 format.
  3. Video Transcription Generation Job: Transcription of the video can be requested by calling Transcription API. This API starts the background job to generate transcription and summary text of the video.

    1. This API returns job_id in response that can be used to check job status using GET Job REST API.
    2. The v2 Transcription API also generates the AI summary with auto-calculated durations (30 secs, 1 min, 5 min, etc.). If you want to generate the AI summary of custom time duration, use v1/transcription/highlights API instead.
  4. Video Summary Generation Job This API generates the text summary of the video and takes time duration as input and the API starts the background job to generate transcription and summary text of the video.

Pictory Jobs is a GET HTTP request and takes Job ID as the Path Parameter. Path Parameter can be obtained from following calling mentioned above 4 jobs.