Detailed specification and usage guide for the Submit API call
Description: Use this call to submit a new job for transcription to Claudio.
- If more than one audio or document is being submitted through a single job, use the Upload Audio and/or Upload Document call to upload one audio/video or document at time, to receive a separate link for each upload. Provide a separate link for each file as per the sample code in the audio and document arrays respectively.
- Audio/Video files can be trimmed to request partial transcripts using the HH:MM:SS format to set start and end times, as per the sample code.
- For jobs profiles that are expected to return a word document, if is_raw is set to 1, then finished_transcript key would be an array of file URLs that contain the transcript word document.
Parameters:
|
Name |
Description |
Usage |
Type |
Required |
|
Key |
API Key provided |
In Request Body |
string |
True |
|
Secret |
API Secret provided |
In Request Body |
string |
True |
|
sample job JSON |
sample job JSON |
In Request Body |
string |
True |
{
Expected Response:
{
"message": "SUCCESS: Job submitted successfully. Please use the polling endpoint to check job status. ",
"poll_endpoint": "<endpoint of polling API>",
"job_reference_id": "<job_reference_id of the job submitted>",
"return": "message, poll_endpoint, job_reference_id"
}
Expected Responses
|
Status |
Meaning |
Description |
|
200 |
OK |
Job submitted successfully |
|
400 |
Bad Request |
Unexpected error occurred |
|
401 |
Unauthorized |
User not authorized |
|
500 |
Internal Server Error |
Internal Server Error |
Next: Poll Job - the Claudio API is an asynchronous API, and you will need to periodically poll the status of the job after submitting it to get the link(s) for the completed transcript(s).