Call a Kodi JSON-RPC API method

Use this action to call a Kodi JSON-RPC API method, for example to trigger a library scan or run an add-on. You can pass any parameters the method accepts.

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 call a method 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 what you want to control. Under By target (see Targets), select the Kodi media player.
6. From the actions shown for that target, select Kodi: Call method.
7. Enter the Method and any parameters it needs.
8. Select Save.

Options in the UI

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 kodi.call_method. A basic example looks like this:

action: kodi.call_method
target:
  entity_id: media_player.kodi
data:
  method: VideoLibrary.Scan

Options in YAML

In addition to the method, you can pass any parameters that the API method accepts.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn 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], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching media_player entity behind that target.

• Entity: one specific media_player entity, such as media_player.living_room.
• Device: every media_player entity that belongs to a device.
• Area: every media_player entity in a room or area.
• Floor: every media_player entity on a floor.
• Label: every media_player entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

When the Kodi JSON-RPC API returns data, Home Assistant fires a kodi_call_method_result event on the event bus, which you can use as an automation trigger. The event data looks like this:

entity_id: media_player.kodi
result_ok: true
input: <the input parameters of the action>
result: <the data received from the Kodi API>

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.

Related actions

These actions work well alongside this one:

• Add music to the Kodi playlist: Adds music to the default Kodi playlist.