API Call - Poll Job

Query:

<base_url>/jobs/<job_reference_id>/poll

base_url: Learn more about getting the base URL as a team admin from here.

job_reference_id: This is the reference ID you will receive after submitting a job through Submit Job API.

Description: Use this call to check status of a job

Parameters:

Name	Description	Usage	Type	Required
Key	API Key provided	In Request Body	text	True
Secret	API Secret provided	In Request Body	text	True
Job Reference ID	Submit Job API response	In query	text	True

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

Request:

{
   "key": "",
   "secret": ""
}

Note: The expected response time for Poll Job is 30 seconds.

Expected Responses

When job status is 'Completed':

{
    "msg": "SUCCESS: Job completed. ",
    "transcript_url": [],
    "media_files": [],
    "extracted_fields": [],
    "return": "msg, transcript_url, media_files, extracted_fields"
}

When job status is 'In Progress':

{
    "msg": "NOTICE: The job is in progress. 
            Please try again after sometime. ",
    "media_files": []
}

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

Note: transcript_url 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_url 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 'Error':

{
    "msg": "ERROR: Job processing failed. 
           Please contact support if this issue persists. "
}

Note: A job may fail for multiple reasons. Please refer to the status code to identify the cause. For example, a status code of 400 indicates that the job failed due to a bad request.

Status	Meaning	Description
200	OK	Job is in progress or complete
400	Bad Request	Unexpected error occurred
401	Unauthorized	User not authorized
500	Internal Server Error	Internal Server Error

Next: If you do not have an automated data retention policy and you want to delete the transcript after it has been downloaded, you can make the Delete call.

Link to Postman Collection

API Call - Poll Job

Detailed specification and usage guide for the Poll API call