API Call - Delete Transcript
Detailed specification and usage guide for the Delete Transcript API call
Query:
<base_url>/jobs/<job_reference_id>/delete
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: If you do not have a data retention policy set on your account to automatically delete all files related to a job after a fixed period of time, use this call to manually delete all data related to a job, including the uploaded audios, supporting documentation, and all generated transcripts. Ensure that you have downloaded the transcript after a job status switches to SUCCESS in response to the Poll API call before deleting the transcript using the Delete Transcript API call.
Parameters:
|
Name |
Description |
Usage |
Type |
Required |
|
Key |
API Key provided |
Request Body |
text |
True |
|
Secret |
API Secret provided |
Request Body |
text |
True |
|
Job Reference ID |
part of Submit Job response |
In query |
text |
True |
Request:
{
"key": "yourapikeygoeshere123456abc",
"secret": "yoursecretkeygoeshere123456789abcdefghijklm123"
}
Expected Responses:
When the job is deleted successfully:
{
"msg": "SUCCESS: Finished Transcript deleted.
Formatted Transcript deleted. Audio file deleted. "
}
Trying to delete a job which is already deleted.
{
"msg": "SUCCESS: NOTICE: Unexpected error during delete.
Finished Transcript not deleted.
NOTICE: Unexpected error during delete.
Formatted Transcript not deleted.
NOTICE: Unexpected error during delete.
Audio file not deleted. "
}
When job_reference_id is incorrect in query:
{
"msg": "ERROR: Unexpected error occured. ERROR: Job data not found. ",
"err_code": "ERR_C_TA_DJTA_001"
}
|
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 |