API Call - Get Job Details

Query:

<base_url>/jobs/<job_reference_id>/details

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 get all the details related to a job

Parameters:

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

Request:

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

Expected Responses

When the input includes both a media file and a document file, and the job status is Complete.

{
    "success": true,
    "msg": "SUCCESS: Job completed successfully.",
    "job_data": {
        "job_info": {
            "job_reference_id": "<job_reference_id>",
            "job_name": "<job_name>",
            "status": "completed",
            "profile_name": "Name of the profile you are using for transcription",
            "submitted_at": "submission timestamp",
            "completed_at": "submission timestamp",
            "total_audio_length": "audio length in seconds",
            "is_blank_audio": false,
            "error_message": null
        },
        "job_files": {
            "input_files": [
                {
                    "filename": "media file name",
                    "file_type": "audio",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the media file"
                },
                {
                    "filename": "document name ",
                    "file_type": "attachment",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the document"
                }
            ],
            "output_files": {
                "transcripts": [
                    {
                        "filename": "IME Doc Extraction.txt",
                        "file_subtype": "final_transcript",
                        "download_url": "S3 URL to access the final transcript in a text file",
                        "language_code": "en"
                    },
                    {
                        "filename": "IME Doc Extraction_LOI.docx",
                        "file_subtype": "final_transcript",
                        "download_url": "S3 URL to access the LOI extractions in a text file",
                        "language_code": "en"
                    },
                    {
                        "filename": "IME Doc Extraction_LTR.docx",
                        "file_subtype": "final_transcript",
                        "download_url": "S3 URL to access the final transcript in a docx/docm file",
                        "language_code": "en"
                    }
                ],
                "processed_input_media": [
                    {
                        "filename": "name of the processed media file",
                        "file_subtype": "merged_filename",
                        "download_url": "S3 URL to access the processed media file"
                    }
                ],
                "extracted_fields_url": "S3 URL to access extracted fields in a JSON format"
            }
        }
    }
}

When the input includes both a media file and a document file and the job status is 'In Progress'.

{
    "success": true,
    "msg": "NOTICE: Job is currently being processed.",
    "job_data": {
        "job_info": {
            "job_reference_id": "<job_reference_id>",
            "job_name": "<job_name>",
            "status": "completed",
            "profile_name": "Name of the profile you are using for transcription",
            "submitted_at": "submission timestamp",
            "completed_at": "submission timestamp",
            "total_audio_length": "audio length in seconds",
            "is_blank_audio": false,
            "error_message": null
        },
        "job_files": {
            "input_files": [
                {
                    "filename": "media file name",
                    "file_type": "audio",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the media file"
                },
                {
                    "filename": "document name ",
                    "file_type": "attachment",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the document"
                }
            ],
            "output_files": null
        }
    }
}

When the input includes only a media file and the job status is Complete.

{
    "success": true,
    "msg": "SUCCESS: Job completed successfully.",
    "job_data": {
        "job_info": {
            "job_reference_id": "<job_reference_id>",
            "job_name": "<job_name>",
            "status": "completed",
            "profile_name": "Name of the profile you are using for transcription",
            "submitted_at": "submission timestamp",
            "completed_at": "submission timestamp",
            "total_audio_length": "audio length in seconds",
            "is_blank_audio": false,
            "error_message": null
        },
        "job_files": {
            "input_files": [
                {
                    "filename": "media file name",
                    "file_type": "audio",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the media file"
                }
            ],
            "output_files": {
                "transcripts": [
                    {
                        "filename": "General Transcription.txt",
                        "file_subtype": "final_transcript",
                        "download_url": "S3 URL to access the final transcript in a text file",
                        "language_code": "en"
                    },
                    {
                        "filename": "General Transcription.docx",
                        "file_subtype": "final_transcript",
                        "download_url": "S3 URL to access the final transcript in a docx/docm file",
                        "language_code": "en"
                    }
                ],
                "processed_input_media": [
                    {
                        "filename": "name of the processed media file",
                        "file_subtype": "merged_filename",
                        "download_url": "S3 URL to access the processed media file"
                    }
                ],
                "extracted_fields_url": null
            }
        }
    }
}

When the input includes only a media file and the job status is 'In Progress'.

{
    "success": true,
    "msg": "NOTICE: Job is currently being processed.",
    "job_data": {
        "job_info": {
            "job_reference_id": "<job_reference_id>",
            "job_name": "<job_name>",
            "status": "completed",
            "profile_name": "Name of the profile you are using for transcription",
            "submitted_at": "submission timestamp",
            "completed_at": "submission timestamp",
            "total_audio_length": "audio length in seconds",
            "is_blank_audio": false,
            "error_message": null
        },
        "job_files": {
            "input_files": [
                {
                    "filename": "media file name",
                    "file_type": "audio",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the media file"
                }
            ],
            "output_files": null
        }
    }
}

When the job status is 'Error'

{
    "success": false,
    "msg": "ERROR: Job processing failed.",
    "job_data": {
        "job_info": {
            "job_reference_id": "<job_reference_id>",
            "job_name": "<job_name>",
            "status": "completed",
            "profile_name": "Name of the profile you are using for transcription",
            "submitted_at": "submission timestamp",
            "completed_at": "submission timestamp",
            "total_audio_length": "audio length in seconds",
            "is_blank_audio": false,
            "error_message": null
        },
        "job_files": {
            "input_files": [
                {
                    "filename": "media file name",
                    "file_type": "audio",
                    "file_size": file size in bytes,
                    "download_url": "S3 URL to access the media file"
                }
            ],
            "output_files": null
        }
    }
}