Download file

Use this action to download a file to the location configured for the Downloader integration.

The download directory must exist and be writable by Home Assistant.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To download a file from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. Select Downloader: Download file.
  6. Enter the URL to download.
  7. Set the other options if you need them.
  8. Select Save.

Options in the UI

URL

The URL of the file to download.

Subdirectory (Optional)

The subdirectory inside the configured download location.

Filename (Optional)

The filename to use for the downloaded file.

Overwrite (Optional)

Whether to overwrite an existing file.

Headers (Optional)

Custom HTTP headers to add to the request.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as downloader.download_file. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: downloader.download_file
data:
  url: "https://example.com/file.txt"

This downloads file.txt to the configured download location.

Options in YAML

url string Required

The URL of the file to download.

subdir string

The subdirectory inside the configured download location.

filename string

The filename to use for the downloaded file.

overwrite boolean

Whether to overwrite an existing file.

headers map

Custom HTTP headers to add to the request.

This action does not support targets.

Good to know

  • If the configured path is not absolute, Home Assistant treats it as relative to the configuration directory.
  • When a download finishes, Home Assistant emits either downloader_download_completed or downloader_download_failed on the event bus.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.