Request Header

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

Response

1. Response Details for a In Progress/Running Job

If the job corresponding to the provided job ID is currently running in the backend, the response you will receive typically includes the following information:

{
    "job_id": "6830fe00-872b-4e96-86b5-e4b527f0295b",
    "success": true,
    "data": {
        "status": "in-progress"
    }
}

2. Response Details for a Completed Job

The completed job response of the Get Job API varies based on the type of job being executed. There are the following types of job:

a. Storyboard Job

For this type of job, the API's response includes a video preview URL and renderParams objects. This allows you to see a preview of the video that has been created based on the script provided.

{
    "success": true,
    "data": {
        "renderParams": {
            "audio": {},
            "output": {},
            "scenes": [],
            "next_generation_video": true,
            "containsTextToImage": true
        },
      "preview": "VIDEO_PREVIEW_URL",
    },
    "job_id"" "4158-asd-4158-fdfe-234-nkn"
}

b. Video Generation or Render Job

In this case, the GET API's response contains the generated video along with related settings. This is the final output where the video is fully rendered and ready for use, based on the script and any specific instructions given for the video creation.

{
    "job_id": "702f8260-c56a-4fbc-9741-ddc44df24aa2",
    "success": true,
    "data": {
        "txtFile": "TEXT_FILE_URL",
        "audioURL": "MP3_FILE_URL",
        "thumbnail": "THUMBNAIL_IMAGE_URL",
        "videoDuration": 13.13,
        "videoURL": "GENERATED_VIDEO_URL",
        "vttFile": "VTT_FILE_URL",
        "srtFile": "SRT_FILE_URL",
        "shareVideoURL": "SHARED_VIDEO_URL",
        "status": "completed"
    }
}

c. Video Transcription/Highlight Job

Video Transcription/Highlight Job: When using this type of job, the API's response includes the text output of the audio used in the video. This is particularly useful for creating transcriptions or highlighting specific parts of the audio content. It allows for a written representation of the spoken content in the video, which can be used for various purposes such as subtitles, accessibility features, or documentation.

{
    "success": true,
    "data": {
        "transcript": [],
          "url": "transcript_settings_Json_URL",
          "srt": "subtitle-text-of-the-video",
          "vtt": "vtt-text-of-the-video",
          "txt": "text-of-the-video",
    }
}