Setup

The STT API establishes the connection using the HTTPS protocol. It uses standard HTTP response codes, authentication, and verbs.

The REV-APPNAME parameter in the Header will identify the API request. The API will recognize the default settings like transcription language, domain by the REV-APP-ID, and REV-API-KEY for each customer account.

Note: On receiving your request, the REV-APP-ID and the REV-API-KEY are forwarded to your email ID to test the API.

Authentication

The STT API will use the App Id and API key to authenticate requests. Your credentials carry many privileges, so be sure to keep them secure.

Use your App Id and API Key by assigning it to REV-APP-ID and REV-API-KEY, respectively.

How does API work?

The process to transcribe an audio file:

1. Post the request by:

   1. Enter the valid REV-APPNAME, REV-APP-ID, and REV-API-KEY

   2. Define the Language Code and domain

   3. Upload the audio file to transcribe

   4. Define the audio format, if required

2. The API will return the text in the requested Indian language.

Sample Code

Request: Transcribing Audio

curl --location --request POST 'https://revapi.reverieinc.com/' \
--header 'src_lang: hi' \
--header 'domain: generic' \
--header 'REV-API-KEY: <YOUR API KEY>' \
--header 'REV-APPNAME: stt_file' \
--header 'REV-APP-ID: <YOUR API-ID>' \
--form 'audio_file=@"<File Path>"'

Request: Transcribing Audio other than Default Format

curl --location --request POST 'https://revapi.reverieinc.com/' \
--header 'src_lang: hi' \
--header 'domain: generic' \
--header 'REV-API-KEY: <YOUR API KEY>' \
--header 'REV-APPNAME: stt_file' \
--header 'REV-APP-ID: <YOUR API-ID>' \
--header 'format: mp3'
--form 'audio_file=@"<File Path>"'

Response: Success

{
    "id": "ddf4ebda44af4fdf95118af9a6f14d46fce12ed85347471d",
    "success": true,
    "final": true,
    "text": "नाइनटी एट पॉइंट थ्री एफएम पर प्ले करिए",
    "cause": "EOF received",
    "confidence": 0.891,
    "display_text": "98.3 एफएम पर प्ले करिए"
}

Response: Error Message

{
    "id": "03e4f260551345e6832bf62ba273e0096fd303e72f94453f",
    "success": false,
    "text": "",
    "final": true,
    "confidence": 1.0,
    "cause": "no file given",
    "display_text": ""  
}