Skip to content

Commit

Permalink
Add elevenlabs integration docs (#32322)
Browse files Browse the repository at this point in the history
* Add elevenlabs integration docs

Add elevenlabs integration docs

* Tiny style tweaks

* Add prerequisites

* Tiny tweak

* Update source/_integrations/elevenlabs.markdown

Co-authored-by: Simon <[email protected]>

---------

Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: Joost Lekkerkerker <[email protected]>
  • Loading branch information
3 people authored Aug 4, 2024
1 parent 43f2937 commit f4f5244
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions source/_integrations/elevenlabs.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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.
## Prerequisites

- 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.

{% 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 by default), select the media player entity or group to send the TTS audio to, and enter the message to speak.

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/).

0 comments on commit f4f5244

Please sign in to comment.