Anthropic

The Anthropic integrationsIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] adds a conversation agent powered by Anthropic, such as Claude 3.5 Sonnet, in Home Assistant.

Controlling Home Assistant is done by providing the AI access to the Assist API of Home Assistant. You can control what devices and entities it can access from the exposed entities page. The AI can provide you information about your devices and control them.

Legal note: Individuals and hobbyists are welcome to use the Anthropic API for personal use, however, please note that the use of the API is subject to their Commercial Terms of Service, regardless of whether you are an individual or representing a company.

Prerequisites

• This integration requires an API key to use, which you can generate here..
• This is a paid service, we advise you to monitor your costs in the Anthropic portal closely.

Generating an API Key

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

1. Log in to the Anthropic portal or sign up for an account.
2. Enable billing with a valid credit card on the plans page.
3. Visit the API Keys page to retrieve the API key you’ll use to configure the integration.

Configuration

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

Options

To define options for Anthropic, follow these steps:

1. In Home Assistant, go to Settings > Devices & services.

2. If multiple instances of Anthropic are configured, choose the instance you want to configure.

3. On the card, select the cogwheel .

   • If the card does not have a cogwheel, the integration does not support options for this device.

   

4. Edit the options, then select Submit to save the changes.

The integration provides the following types of subentries:

• Conversation
• AI Task

If you choose not to use the recommended settings, you can configure the following options:

Supported features

Models

We generally support all Anthropic models, with one caveat: when a new model is released, it may introduce non-backward-compatible features, and it can take up to two Home Assistant releases for these features to be supported in the stable release.

Feature matrix

The following table describes which API features are supported and which are not. In general, we don’t support beta features.

Model capabilities

Tools

Context management

Use cases

The integration provides conversation and ai_task entities powered by Anthropic API. Please refer to the corresponding integrations for more details and examples:

• Conversation
• AI Task

A few examples:

Assist pipeline

Set up and configure Claude as a conversation agent in an Assist pipeline as described in the voice guide. You can then use this pipeline to chat through the Home Assistant web interface, on Android or Apple devices using the Home Assistant Companion App, or by voice using an Assist satellite.

Expose entities and configure aliases for the entities you want the model to control.

Home Assistant interface

You can set the Claude AI Task entity as the default AI Task entity. To do this, go to Settings > System > AI tasks and select the Claude AI Task entity. This makes the Claude AI Task entity the default for blueprints, and for the Suggest with AI button in various places in the interface.

Automation

You can use conversation.process and ai_task.generate_data actions in your scripts and automations. Here is a simple automation that implements a Claude Telegram chatbot using Telegram bot integration:

triggers:
  - trigger: state
    entity_id:
      - event.bot_update_event # Replace with your Telegram bot event entity
conditions: "{{ trigger.to_state.attributes.event_type == 'telegram_text' }}"
actions:
  - action: conversation.process
    data:
      agent_id: conversation.claude_conversation # Replace with your Claude conversation entity
      conversation_id: "telegram_{{ trigger.to_state.attributes.chat_id }}"
      text: "{{ trigger.to_state.attributes.text }}"
    response_variable: response
  - action: telegram_bot.send_message
    data:
      chat_id: "{{ trigger.to_state.attributes.chat_id }}"
      message: "{{ response.response.speech.plain.speech }}"
      parse_mode: plain_text
      config_entry_id: "{{ trigger.to_state.attributes.bot.config_entry_id }}"

Troubleshooting

The response is truncated mid-sentence, or the model said it would do an action to control a device but didn’t do it

This may happen when the Maximum Tokens to Return in Response integration option value is too small. A small conservative limit is good to keep the cost lower, but it may be suboptimal in certain cases.

Integration fails to set up, the logs show ImportError or AttributeError

This may happen if the Python anthropic client had failed to upgrade to the correct version. If you know how to log into the Home Assistant container and manually reinstall the client, try that. Otherwise, downgrading and re-upgrading Home Assistant should help.

Known limitations

This integration does not integrate with sentence triggers.

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.