OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update openai-edge-tts-integration.md

Browse Source 
Updated docs for OpenAI Edge TTS with latest updates regarding new markdown filter support and API expansion
This commit is contained in:
Travis Van Nimwegen 2025-01-08 16:53:24 -05:00 committed by GitHub
parent fe642b4d6d
commit 2e9e1c79d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/tutorials/text-to-speech/openai-edge-tts-integration.md
View File

@ -1,6 +1,6 @@
--- ---
sidebar_position: 1 sidebar_position: 1
title: "🗨️ Openai-edge-tts Using Docker" title: "🗨️ Edge TTS Using Docker"
--- ---
:::warning :::warning
@ -41,7 +41,7 @@ This will run the service at port 5050 with all the default configs
- Set your TTS Settings to match the screenshot below - Set your TTS Settings to match the screenshot below
- _Note: you can specify the TTS Voice here_ - _Note: you can specify the TTS Voice here_
![Screenshot of Open WebUI Admin Settings for Audio adding the correct endpoints for this project](https://utfs.io/f/MMMHiQ1TQaBo9GgL4WcUbjSRlqi86sV3TXh47KYBJCkdQ20M) ![Screenshot of Open WebUI Admin Settings for Audio adding the correct endpoints for this project](https://utfs.io/f/MMMHiQ1TQaBobmOhsMkrO6Tl2kxX39dbuFiQ8cAoNzysIt7f)
:::info :::info
The default API key is the string `your_api_key_here`. You do not have to change that value if you do not need the added security. The default API key is the string `your_api_key_here`. You do not have to change that value if you do not need the added security.
@ -107,6 +107,8 @@ DEFAULT_SPEED=1.2
DEFAULT_LANGUAGE=en-US DEFAULT_LANGUAGE=en-US
REQUIRE_API_KEY=True REQUIRE_API_KEY=True
REMOVE_FILTER=False
EXPAND_API=True
``` ```
#### 5. Run the Server #### 5. Run the Server
@ -125,7 +127,7 @@ You can now interact with the API at `http://localhost:5050/v1/audio/speech` and
#### Usage #### Usage
##### Endpoint: `/v1/audio/speech` ##### Endpoint: `/v1/audio/speech` (aliased with `/audio/speech`)
Generates audio from the input text. Available parameters: Generates audio from the input text. Available parameters:
@ -193,6 +195,14 @@ curl -X POST http://localhost:5050/v1/audio/speech \
- **POST/GET /v1/voices**: Lists `edge-tts` voices for a given language / locale. - **POST/GET /v1/voices**: Lists `edge-tts` voices for a given language / locale.
- **POST/GET /v1/voices/all**: Lists all `edge-tts` voices, with language support information. - **POST/GET /v1/voices/all**: Lists all `edge-tts` voices, with language support information.
:::info
The `/v1` is now optional.
Additionally, there are endpoints for **Azure AI Speech** and **ElevenLabs** for potential future support if custom API endpoints are allowed for these options in Open WebUI.
These can be disabled by setting the environment variable `EXPAND_API=False`.
:::
## 🐳 Quick Config for Docker ## 🐳 Quick Config for Docker
You can configure the environment variables in the command used to run the project You can configure the environment variables in the command used to run the project
@ -206,14 +216,22 @@ docker run -d -p 5050:5050 \
-e DEFAULT_SPEED=1.2 \ -e DEFAULT_SPEED=1.2 \
-e DEFAULT_LANGUAGE=en-US \ -e DEFAULT_LANGUAGE=en-US \
-e REQUIRE_API_KEY=True \ -e REQUIRE_API_KEY=True \
-e REMOVE_FILTER=False \
-e EXPAND_API=True \
travisvn/openai-edge-tts:latest travisvn/openai-edge-tts:latest
``` ```
:::note
The markdown text is now put through a filter for enhanced readability and support.
You can disable this by setting the environment variable `REMOTE_FILTER=True`.
:::
## Additional Resources ## Additional Resources
For more information on `openai-edge-tts`, you can visit the [GitHub repo](https://github.com/travisvn/openai-edge-tts) For more information on `openai-edge-tts`, you can visit the [GitHub repo](https://github.com/travisvn/openai-edge-tts)
For direct support, you can visit the [Voice AI & TTS Discord](https://discord.gg/GkFbBCBqJ6) For direct support, you can visit the [Voice AI & TTS Discord](https://tts.travisvn.com/discord)
## 🎙️ Voice Samples ## 🎙️ Voice Samples