Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onyx.app/llms.txt

Use this file to discover all available pages before exploring further.

The Voice Mode action allows your users to have spoken conversations with Onyx using speech-to-text and text-to-speech providers.

​
Setting up Voice Mode

1

Navigate to the Voice Mode Dashboard

Click your user profile icon and select Admin Panel, then select the Voice Mode tab in the sidebar.Voice Mode dashboard in Onyx Admin Panel
2

Set up Speech-to-Text (STT) provider

Configure a provider to transcribe user speech into text.Speech-to-Text Providers
1

Get an OpenAI API key

Navigate to the OpenAI dashboard and create a new API key, or reuse an existing OpenAI API key already configured for your LLM provider.
2

Enter the API key

Click Connect and enter the API key.
3

Set up Text-to-Speech (TTS) provider

Configure a provider to convert AI responses into spoken audio.Text-to-Speech Providers
1

Get an OpenAI API key

Navigate to the OpenAI dashboard and create a new API key (or reuse the one from Whisper).
2

Enter the API key

Click Connect and enter the API key.
Once your TTS provider is configured, select a voice from the dropdown or input a voice ID directly.Voice Selection
4

Set Default Provider

If you have multiple providers configured, make sure to Set as Default for both your preferred STT and TTS provider.Set Default Provider
Make sure your users have microphone access enabled in their browser to use Voice Mode.