OpenRouter

The OpenRouter integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to use the OpenRouter API as a conversation agent in Home Assistant.

This integration provides a way to interact with a wide range of AI models available on OpenRouter, while billing is handled by OpenRouter. You can even use your own third-party (like OpenAI) API key.

Configuration

To add the OpenRouter service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select OpenRouter.

  • Follow the instructions on screen to complete the setup.

Generate an API Key

The API key is used to authenticate requests to OpenRouter. To generate an API key take the following steps:

  • Log in to OpenRouter or sign up for an account.
  • Go to the API Keys section in your account settings.
  • To generate a new key, select Create API Key.
  • Give the key a name, and be sure to set up billing limits.

Supported functionality

Generating data with AI

The OpenRouter integration allows you to generate data using AI models available on OpenRouter. You can use this functionality in automations, scripts, or directly in the Home Assistant UI.

Removing the integration

This integration follows standard integration removal, no extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three dots menu. Then, select Delete.