-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add elevenlabs integration docs #32322
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: ElevenLabs text-to-speech | ||
description: Instructions on how to setup ElevenLabs text-to-speech with Home Assistant. | ||
ha_category: | ||
- Text-to-speech | ||
ha_release: 2024.8 | ||
ha_iot_class: Cloud Push | ||
ha_domain: elevenlabs | ||
ha_platforms: | ||
- tts | ||
ha_config_flow: true | ||
ha_integration_type: integration | ||
--- | ||
|
||
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. | ||
|
||
{% include integrations/config_flow.md %} | ||
|
||
For an overview of which languages can be used, check the [complete list of supported languages](https://elevenlabs.io/languages). | ||
|
||
For a description of which voices are available for use, check your VoiceLab voices. | ||
|
||
To see the available models and their benefits, check the [models documentation](https://elevenlabs.io/docs/speech-synthesis/models). | ||
|
||
## Action speak | ||
|
||
The `tts.speak` action is the modern way to use TTS. Add the `speak` action, select the entity for your ElevenLabs TTS (it's named ElevenLabs), select the media player entity or group to send the TTS audio to, and enter the message to speak. | ||
joostlek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
For more options about `speak`, see the Speak section on the main [TTS](/integrations/tts/#service-speak) building block page. | ||
|
||
In YAML, your action will look like this: | ||
|
||
```yaml | ||
action: tts.speak | ||
target: | ||
entity_id: tts.elevenlabs | ||
data: | ||
media_player_entity_id: media_player.giant_tv | ||
message: Hello, can you hear me now? | ||
``` | ||
|
||
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/). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any prerequisites? Do I need to have something before I can add the integration? an ElevenLabs account, credentials, API key?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a draft for prerequisites