Getting the Asynchronous Transcription Result
After you submit an audio file for transcription, the "status" key will go from "queued" to "processing" to "completed." You can make a GET request, as shown on the code snippets below, to check for updates on the status of your transcription.
You'll have to make repeated GET requests until the status is "completed" or "error." Once the status key is shown as "completed," you'll see your submitted file's results and other metadata.
The API endpoint to retrieve your results is https://api.voice.virlow.com/v1-beta/transcript/status
You need to pass the API Key to our API using the x-api-key parameter via the query string and the id of the submitted job.
curl --location --request GET 'https://api.voice.virlow.com/v1-beta/transcript/status?id=YOUR_JOB_ID&x-api-key=YOUR_KEY'
Response Object
The results of the transcript will be within the results key. The results will only be returned when the job has been completed.
{
"id": "e413b9a2-a8c8-43d1-b53c-6a9f2dc3b723",
"status": "completed",
"dual_channel": true,
"punctuate": true,
"webhook_url": "",
"custom": "YOUR_VALUE",
"speaker_diarization": false,
"language": "enUs",
"timestamp_submitted": "2022-05-12T19:04:57.063Z",
"results": {
"job_data": {
"id": "e413b9a2-a8c8-43d1-b53c-6a9f2dc3b723",
"status": "completed",
"dual_channel": true,
"punctuate": true,
"webhook_url": "",
"custom": "YOUR_VALUE1",
"speaker_diarization": false,
"language": "enUs",
"timestamp_submitted": "2022-04-15T13:47:12.720Z"
},
"results": {
"transcript": "Thank you for holding my name is ...",
"tldr": "The customer is calling to update their plan ...",
"short_hand_notes": "I was speaking with a customer service representative ...",
"words": [
{
"startTime": 1520,
"endTime": 1600,
"word": "thank"
},
{
"startTime": 1680,
"endTime": 1760,
"word": "you"
},
{
"startTime": 1840,
"endTime": 1920,
"word": "for"
},
{
"startTime": 2080,
"endTime": 2400,
"word": "holding"
},
{
"startTime": 2480,
"endTime": 2560,
"word": "my"
},
{
"startTime": 2640,
"endTime": 2720,
"word": "name"
},
{
"startTime": 2800,
"endTime": 2880,
"word": "is"
},
{
"startTime": 2960,
"endTime": 3520,
"word": "..."
}
]
}
}
}
You can also view the status of your job in the Virlow Console. Navigate to Jobs, and you will be able to see up to 90 days of jobs submitted to the Virlow API.