> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/speech-to-text.md).
# Speech To Text
### Speech To Text From Sound Wave
* **Description:** Transcribes the provided audio.
**Inputs:**
* **Sound Wave:** The recorded output from the microphone, please take a look over the tutorial/sample project for an example on how to use Convai voice capture component with the API.
**Outputs:**
#### ✅ \[On Success]
**Response:** Contains the text output of the audio file if the API was successful, otherwise might contain information on why the API call failed.
#### ⛔ \[On Failure]
*Nothing is returned, check logs for details on why it failed.*
### Speech To Text From Sound Wave
* **Description:** Transcribes the provided audio file.
**Inputs:**
* **Filename:** The path to the recorded audio file on your local disk, the file should be in a .wav format.
**Outputs:**
#### ✅ \[On Success]
**Response:** Contains the text output of the audio file if the API was successful, otherwise might contain information on why the API call failed.
#### ⛔ \[On Failure]
*Nothing is returned, check logs for details on why it failed.*
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/speech-to-text.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.