Text-to-speech (TTS)

Text-to-speech (TTS) enables Home Assistant to speak to you.

Building block integration

This text-to-speech (tts) is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this text-to-speech (tts) building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the text-to-speech (tts) building block offers.

See all TTS integrations using this building block for ways to use it in your automations. If you are using the Home Assistant voice assistant, Assist, Assist is using TTS when replying to you. Another way to use TTS is by using TTS with Home Assistant Cloud.


Service speak

Modern platforms will create entities under the tts domain, where each entity represents one text-to-speech service provider. These entities may be used as targets for the tts.speak service.

The tts.speak service supports language and on some platforms also options for settings, e.g., voice, motion, speed, etc. The text that should be spoken is set with message, and the media player that should output the sound is selected with media_player_entity_id.

service: tts.speak
  entity_id: tts.example
  media_player_entity_id: media_player.kitchen
  message: "May the force be with you."

Service say (legacy)

The say service supports language and on some platforms also options for settings, e.g., voice, motion, speed, etc. The text that should be spoken is set with message. Since release 0.92, service name can be defined in configuration service_name option.

Say to all media_player entities:

# Replace google_translate_say with <platform>_say when you use a different platform.
service: tts.google_translate_say
  entity_id: all
  message: "May the force be with you."

Say to the media_player.floor entity:

service: tts.google_translate_say
  entity_id: media_player.floor
  message: "May the force be with you."

Say to the media_player.floor entity in French:

service: tts.google_translate_say
  entity_id: media_player.floor
  message: "Que la force soit avec toi."
  language: "fr"

With a template:

service: tts.google_translate_say
  message: "Temperature is {{states('sensor.temperature')}}."
  cache: false


The integration cache can be controlled with the cache option in the service call to speak or say. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period.


POST /api/tts_get_url

Returns a URL to the generated TTS file. The engine_id or platform parameter together with message are required.

  "engine_id": "tts.amazon_polly",
  "message": "I am speaking now"

The return code is 200 if the file is generated. The message body will contain a JSON object with the URL.

  "path": "/api/tts_proxy/265944c108cbb00b2a621be5930513e03a0bb2cd_en_-_tts.demo.mp3",
  "url": ""

Sample curl command:

$ curl -X POST -H "Authorization: Bearer <ACCESS TOKEN>" \
       -H "Content-Type: application/json" \
       -d '{"message": "I am speaking now", "engine_id": "amazon_polly"}' \


Depending on your setup, you might need to set an external URL (external_url) inside the configuration.

The following sections describe some of the problems encountered with media devices.

Self-signed certificates

This problem occurs when your Home Assistant instance is configured to be accessed through SSL, and you are using a self-signed certificate on your internal URL.

The tts service will send an https:// URL to the media device, which will check the certificate, and reject it. So it won’t play your file. If you could make the device accept your certificate, it would play the file. However, many media devices do not allow changing settings to accept self-signed certificates. Ultimately, your option may be to serve files to local devices as http:// rather than https://.

Google cast devices

The Google cast devices (Google Home, Chromecast, etc.) present the following problems:

  • They reject self-signed certificates.

  • They do not work with URLs that contain hostnames established by local naming means. Let’s say your Home Assistant instance is running on a machine made known locally as ha. All your machines on your local network are able to access it as ha. However, try as you may, your cast device won’t download the media files from your ha machine. That’s because your cast device ignores your local naming setup. In this example, the say service creates a URL like http://ha/path/to/media.mp3 (or https://... if you are using SSL). If you are not using SSL then setting an internal URL that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname.

  • If you are using SSL (e.g., https://yourhost.example.org/...) then you must use the hostname in the certificate (e.g., external_url: https://yourhost.example.org). You cannot use an IP address since the certificate won’t be valid for the IP address, and the cast device will refuse the connection.