How Does API Work?
The process to transcribe an audio file:- Post the request by:
- Enter the valid
REV-APPNAME,REV-APP-ID, andREV-API-KEY. - Define the Language Code and domain.
- Upload the audio file to transcribe.
- Define the audio format, if required.
- Enter the valid
- The API will return the text in the requested Indian language.
cURL for Integration
Step 1 : Upload the Audio File
Request : Transcribing Audio
Request: Transcribing Audio other than Default Format
Response: Success
Response: Error Message
API References
HTTP Request URL
Headers
string
required
API key shared by the Reverie team
string
required
APP ID shared by the Reverie team
string
required
Value if this string should always be
stt_filestring
required
- Specify the language code.
- Example:
hi - Refer to section Language Codes for valid language code.
string
required
- 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.
string
- Mention the audio sample rate and file format of the uploaded file.
- Refer to section Supported Audio Formats for valid audio format code.
- 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.
- By default, the format =
Query Parameter
file
required
- An audio file for which the transcript is desired.
Response
string
- A unique Identity number auto-assigned by the API for each request, to be used to fetch job status and transcripts.
boolean
- Provides true or false based on the nature of the response returned by the API.
boolean
- Provides whether the response is the final response returned by the API.
string
- Provides the trascripted response returned by the API for the audio file.
string
- Reason for obtaining the final output, generally due to End Of File (EOF) received.
float
- Provides the confidence on the scale of 0 - 1 for the output.
string
- Provides the display text for the final output based on some post processing.