API Call - Poll Job

Detailed specification and usage guide for the Poll API call

Description: Use this call to check status of a job

Parameters:

Replace with the Job reference ID obtained in the response of Submit Job API

{

"key": "<api_key>",

Expected Responses

When job status is Complete

{

    "msg": "SUCCESS: Job completed. ",

    "transcript_location": [],

    "media_files": [],

    "return": "msg, transcript_location"

}

Update: the final converted (cropped and merged if was part of submit job request) media_file is available in the response.

Note: transcript_location returns an array of transcript locations instead of a string.  This support was added to allow for the generation of multiple documents for a single job request.  

Clicking on any of the URLs in the transcript_location array in the API response will allow you to download the document at that location.  The URL is an encrypted location that will expire within a fixed limited period after the link is generated.  You will need to make a renewed Poll request to get an updated link.  

Depending on the data retention policies for your account, the transcript might automatically be deleted within a pre-determined period after the creation of the document.  If the transcript is deleted, the URL of the transcript will contain a PDF indicating that the transcript is deleted

When job status is In-Progress

{

    "msg": "NOTICE: The job is in progress. Please try again after some time. "

}

When job status is Error

Link to Postman Collection