Speech To Text API
All the available APIs needed to generate transcript from audio files.
Speech to Text
This endpoint is called for transcribing an audio file.
POST
https://api.convai.com/stt/
The user can send the audio file they want to transcribe to this endpoint and get the transcript in the response.
This endpoint also has an option for enabling time stamps, which will provide the timestamp along with the transcript.
Headers
Name | Type | Description |
---|---|---|
CONVAI-API-KEY* | String | User's Convai API Key |
Request Body
Name | Type | Description |
---|---|---|
file* | Audio File | The audio file that the user wants to transcribe. Accepted Formats: wav / mp3 |
enableTimestamps | Boolean | Set to True if the user wants time stamps along with the transcript else False. Default: False |
Here some ample codeto demonstrate the request format for th endpoint -->
Please note currently the API only supports and format for audio files. Sending audio files of other formats such as aac, flac, etc will result in a rror.
Note: The audio should have a bit depth of at least 16 bits or higher.
Add Words
Adding specific words to be focused upon during the Speech-To-Text processing
POST
https://api.convai.com/stt/add-words
This API is called to add new words that the user wants to focus on during the Speech to Text processing. Users can use this endpoint to add uncommon words, that they expect in their audio files and want the Speech-to-Text system to correctly recognize them.
Headers
Name | Type | Description |
---|---|---|
CONVAI-API-KEY* | String | User's Convai API Key |
Request Body
Name | Type | Description |
---|---|---|
word* | String | The word, the user wants to add. |
Here are some sample codes to demonstrate the request format for the endpoint -->
Last updated