API Reference
HTTP Request URL
URL Elements
https://(hostname)
Sample URL
https://revapi.reverieinc.com/upload
Header
REV-API-KEY
String
Yes
API key shared by the Reverie team
REV-APP-ID
String
Yes
APP ID shared by the Reverie team
REV-APPNAME
String
Yes
Value if this string should always be “stt_batch” (without the double quotes)
domain
String
Yes
This field identifies your use case type and set of the terminology defined for transcription.
e.g. for general audio is ‘generic’
It is only required for the first API i.e Upload File API.
src_lang
String
Yes
Specify the language code.
format
String
No
Mention the audio sample rate and file format of the uploaded file.
It is only required for the first API i.e Upload File API
Note -
By default, the format = 16k_int16. (WAV, Signed 16 bit, 16,000 or 16K Hz).
It is an optional parameter.
Query Parameter
file
file
Yes
An audio file for which the transcript is desired.
Response
job_id
String
A unique Identity number auto-assigned by the API for each request, to be used to fetch job status and transcripts.
code
String
Provides a message code which can be used to look up the nature of the response returned by the API.
message
String
Provides a brief description about the response returned by the API.
Handling Errors
Our API raises errors when there is something wrong with certain aspects of the submitted file or any network issues. Some areas where errors might come up would be errors due to network related issues, file formats, incorrect domain names or language codes. Each response code provides a descriptive message about what has gone wrong.
API Response Message Codes
000
Success. Request accepted
001
Language code is required
002
File type not supported. Upload only wav, flac or mp3 formats. Preferred format for transcription is wav files
003
Language and/or Domain not available
004
File type not supported. Upload only wav, flac or mp3 formats. Preferred format for transcription is wav files
999
Unknown error, please contact developer
HTTP Status URL
URL Elements
https://(hostname)
Sample URL
https://revapi.reverieinc.com/status?job_id=<job_id>
Query Parameter
job_id
String
Yes
job_id received after uploading the file.
Status Query Response
job_id
String
A unique Identity number auto-assigned by the API for each request
code
String
provides a message code which can be used to look up the nature of the response returned by the API
message
String
Provides a brief description about the response returned by the API
status
String
status values: “queued”, “processing”, “failed” and “completed”
Status Types
queued
When the file is successfully validated, the request is queued for processing.
processing
The transcript generation process is in progress.
failed
Due to network issues, availability constraints, etc., the request might fail during processing.
completed
Transcription was successfully completed.
API Response Message Codes
000
Transcript ready
001
Invalid JOB ID
002
Invalid JOB ID
003
Your request is in the queue and will be processed shortly
004
Your request is being processed
005
Job failed. Please contact the developers
999
Unknown error
HTTP Transcript URL
URL Elements
https://(hostname)
Sample URL
https://revapi.reverieinc.com/transcript?job_id=<job_id>
Query Parameter
job_id
String
Yes
job_id received after uploading the file.
Transcript Query Response
job_id
String
A unique Identity number auto-assigned by the API for each request.
code
String
Provides a message code which can be used to look up the nature of the response returned by the API.
message
String
Provides a brief description about the response returned by the API.
result
String
An array of transcript objects including, channel_number, transcript, list of words with start time, end time and confidence.Please check the sample response.
API Transcript Response Message Codes
000
Transcript ready
001
Invalid JOB ID
002
Invalid JOB ID
003
Your request is in the queue and will be processed shortly
004
Your request is being processed
005
Job failed. Please contact the developers
999
Unknown error
Last updated