Add speak action configuration for ElevenLabs (#36522)

* Add speak action configuration for ElevenLabs

* tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Simon 2025-01-28 13:29:28 +00:00 committed by GitHub
parent e176182a18
commit 7a1cbb4a2b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -15,11 +15,12 @@ ha_codeowners:
---
The **ElevenLabs** text-to-speech {% term integrations %} adds support for [ElevenLabs](https://elevenlabs.io/) as text-to-speech to read a text with natural sounding voices.
## Prerequisites
- You need an ElevenLabs account to use this integration. A free account suffices for basic usage.
- You need an ElevenLabs account to use this integration. A free account suffices for basic usage.
- For custom voices or more quota you need a subscription.
- You need your API key from the ElevenLabs website.
- You need your API key from the ElevenLabs website.
{% include integrations/config_flow.md %}
@ -44,8 +45,28 @@ target:
data:
media_player_entity_id: media_player.giant_tv
message: Hello, can you hear me now?
options:
voice: <voice-id>
model: <model-id>
```
### Configuration
Below settings can be configured in the options of the integration and in the `options` parameter of the `tts.speak` service.
{% configuration %}
voice:
description: "Voice ID for the ElevenLabs voice to use. Will override the default voice of the entity!"
required: false
type: string
model:
description: "Model ID for the model to use. Will override the default model of the entity!"
required: false
type: string
{% endconfiguration %}
For more information about using text-to-speech with Home Assistant and more details on all the options it provides, see the [TTS documentation](/integrations/tts/).
## Removing the integration