2026.6.3
Home ▸ Actions

Clear keyboard text

Use this action to clear the text in the currently focused input field on an Apple TV. This is helpful for starting a fresh search from an automation or a script.

The on-screen keyboard must be focused on the Apple TV for this action to work.

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 clear keyboard text 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. From the search box, search for and select Apple TV: Clear keyboard text.
  6. Choose the Apple TV you want to clear the text on.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Apple TV

The Apple TV to clear the text on.

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 apple_tv.clear_keyboard_text. 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: apple_tv.clear_keyboard_text
data:
  config_entry_id: YOUR_CONFIG_ENTRY_ID

This clears the text in the focused input field on the selected Apple TV.

Options in YAML

config_entry_id string Required

The config entry ID of the Apple TV to clear the text on.

Good to know

  • You can find the config_entry_id under Settings > Devices & services > Apple TV > your device. It is the last part of the URL when viewing the device page.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

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.

Related actions

These actions work well alongside this one:

  • Set keyboard text: Sets the text in the currently focused text input field on an Apple TV.

  • Append keyboard text: Appends text to the currently focused text input field on an Apple TV.