> ## Documentation Index > Fetch the complete documentation index at: https://docs.reverieinc.com/llms.txt > Use this file to discover all available pages before exploring further. # Getting Started > An introduction to getting transcription data from pre-recorded audio files. This guide will walk you through how to transcribe pre-recorded audio with the Reverie API. We provide two scenarios to try: transcribe a remote file and transcribe a local file. > [!NOTE] > > Before you start, you'll need to follow the steps in the [Get your API > Credentials](https://docs.reverieinc.com/authentication.md) to obtain your API key. ## Make your first Call Make your first API Call using the cURL request. Add your own API Credentials where it says `` & `` and then run the following example in a terminal or your favorite API client. ### Step 1 : Upload the Audio File #### Request : Transcribing Audio ```bash theme={null} curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'src_lang: hi' \ --header 'domain: generic' \ --header 'REV-API-KEY: ' \ --header 'REV-APPNAME: stt_file' \ --header 'REV-APP-ID: ' \ --form 'audio_file=@"" ``` #### Request: Transcribing Audio other than Default Format ```bash theme={null} curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'src_lang: hi' \ --header 'domain: generic' \ --header 'REV-API-KEY: ' \ --header 'REV-APPNAME: stt_file' \ --header 'REV-APP-ID: ' \ --header 'format: mp3' --form 'audio_file=@""' ``` #### Response: Success ```json theme={null} { "id": "ddf4ebda44af4fdf95118af9a6f14d46fce12ed85347471d", "success": true, "final": true, "text": "नाइनटी एट पॉइंट थ्री एफएम पर प्ले करिए", "cause": "EOF received", "confidence": 0.891, "display_text": "98.3 एफएम पर प्ले करिए" } ``` #### Response: Error Message ```json theme={null} { "id": "03e4f260551345e6832bf62ba273e0096fd303e72f94453f", "success": false, "text": "", "final": true, "confidence": 1.0, "cause": "no file given", "display_text": "" } ``` ## API References ### HTTP Request URL | URL Elements | Sample URL | | - | - | | https\://(hostname) | [https://revapi.reverieinc.com/](https://revapi.reverieinc.com/) | #### Headers **REV-API-KEY** `string` *required* API key shared by the Reverie team **REV-APP-ID** `string` *required* APP ID shared by the Reverie team **REV-APPNAME** `string` *required* Value if this string should always be `stt_file` **src\_lang** `string` *required* * Specify the language code. \\ * Example: `hi` \\ * Refer to section [Language Codes](https://docs.reverieinc.com/usage-guides/speech-to-text/supported-languages.md) for valid language code. **domain** `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. **format** `string` * Mention the audio sample rate and file format of the uploaded file. \\ * Refer to section [Supported Audio Formats](https://docs.reverieinc.com/usage-guides/speech-to-text/supported-audio-formats.md) 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. #### Query Parameter **audio\_file** `file` *required* * An audio file for which the transcript is desired. #### Response **id** `string` * A unique Identity number auto-assigned by the API for each request, to be used to fetch job status and transcripts. **success** `boolean` * Provides true or false based on the nature of the response returned by the API. **final** `boolean` * Provides whether the response is the final response returned by the API. **text** `string` * Provides the trascripted response returned by the API for the audio file. **cause** `string` * Reason for obtaining the final output, generally due to End Of File (EOF) received. **confidence** `float` * Provides the confidence on the scale of 0 - 1 for the output. **display\_text** `string` * Provides the display text for the final output based on some post processing. ## SDKs Reverie has several SDKs that can make it easier to use the API. Follow these steps to use the SDK of your choice to make a Reverie Speech-to-Text request. ## Install Dependencies ```bash JavaScript theme={null} npm i @reverieit/reverie-client ``` ```bash Python theme={null} pip install reverie-sdk ``` ## Transcribe Audio from an Audio File To automatically transcribe pre-recorded audio using Reverie’s SDK, follow these steps ```javascript Javascript theme={null} const ReverieClient = require("@reverieit/reverie-client"); const reverieClient = new ReverieClient({ apiKey: "YOUR-API-KEY", appId: "YOUR-APP-ID", }); const response = await reverieClient.stt_file({ audioFile: file, language: lang, }); console.log("Response from API:", response); ``` ```python Python theme={null} from reverie_sdk import ReverieClient client = ReverieClient( api_key="", app_id="", ) resp = client.asr.stt_file( src_lang="en", data=open("./path/to/audio.wav", "rb").read(), ) print(resp) ``` ```go GoLang theme={null} package main import ( "bytes" "encoding/json" "fmt" "io/ioutil" "mime/multipart" "net/http" "os" ) const ( apiURL = "https://revapi.reverieinc.com/" apiKey = "your_api_key" appID = "your_app_id" appName = "stt_file" srcLang = "en" domain = "generic" audioPath = "audio.wav" ) type ApiResponse struct { DisplayText string `json:"display_text"` } func transcribeAudio(filePath string) (string, error) { file, err := os.Open(filePath) if err != nil { return "", fmt.Errorf("error opening file: %v", err) } defer file.Close() var requestBody bytes.Buffer writer := multipart.NewWriter(&requestBody) part, err := writer.CreateFormFile("audio_file", filePath) if err != nil { return "", fmt.Errorf("error creating form file: %v", err) } fileBytes, err := ioutil.ReadAll(file) if err != nil { return "", fmt.Errorf("error reading file: %v", err) } part.Write(fileBytes) writer.Close() req, err := http.NewRequest("POST", apiURL, &requestBody) if err != nil { return "", fmt.Errorf("error creating request: %v", err) } req.Header.Set("src_lang", srcLang) req.Header.Set("domain", domain) req.Header.Set("REV-API-KEY", apiKey) req.Header.Set("REV-APPNAME", appName) req.Header.Set("REV-APP-ID", appID) req.Header.Set("Content-Type", writer.FormDataContentType()) client := &http.Client{} resp, err := client.Do(req) if err != nil { return "", fmt.Errorf("error sending request: %v", err) } defer resp.Body.Close() body, err := ioutil.ReadAll(resp.Body) if err != nil { return "", fmt.Errorf("error reading response: %v", err) } var apiResponse ApiResponse if err := json.Unmarshal(body, &apiResponse); err != nil { return "", fmt.Errorf("error parsing JSON: %v", err) } return apiResponse.DisplayText, nil } func main() { transcription, err := transcribeAudio(audioPath) if err != nil { fmt.Println("Error:", err) return } fmt.Println("Transcription:", transcription) } ``` ## Results In order to see the results from Reverie, you must run the application. Run your application from the terminal. Your transcripts will appear in your shell. ```bash JavaScript theme={null} # Run your application using the file you created in the previous step # Example: npm start ``` ```python Python theme={null} # Run your application using the file you created in the previous step # Example: python main.py ``` ```go GoLang theme={null} // Run your application using the file you created in the previous step // Example: go run main.go ``` ## Analyzing the Response ```json theme={null} { "id": "ddf4ebda44af4fdf95118af9a6f14d46fce12ed85347471d", "success": true, "final": true, "text": "नाइनटी एट पॉइंट थ्री एफएम पर प्ले करिए", "cause": "EOF received", "confidence": 0.891, "display_text": "98.3 एफएम पर प्ले करिए" } ``` In this response we see: * `id` : A unique Identity number auto-assigned by the API for each request. * `success` : Provides a message code which can be used to look up the nature of the response returned by the API. * `final` :Provides a brief description about the response returned by the API. * `text` : An array of transcript objects including, channel\_number, transcript, list of words with start time, end time and confidence.Please check the sample response. * `cause` : An array of transcript objects including, channel\_number, transcript, list of words with start time, end time and confidence.Please check the sample response. * `confidence` : An array of transcript objects including, channel\_number, transcript, list of words with start time, end time and confidence.Please check the sample response. * `display_text` : An array of transcript objects including, channel\_number, transcript, list of words with start time, end time and confidence.Please check the sample response. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.