Karakeep

The Karakeep integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to connect your Karakeep instance to Home Assistant and monitor bookmark statistics.

Karakeep is a self-hostable bookmarking and read-it-later service for saving, organizing, and tagging links, notes, images, and other content.

Prerequisites

To use this integration, you need:

  • A running Karakeep instance that Home Assistant can reach.
  • A Karakeep API key.
Create an API key
  1. Log in to your Karakeep instance.
  2. Go to Settings > API Keys.
  3. Create a new API key.
  4. If your Karakeep instance is version 0.32.0 or later and uses granular scopes, grant the API key the User account > read scope.
  5. Copy the API key and use it during setup in Home Assistant.

Configuration

To add the Karakeep 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 Karakeep.

  • Follow the instructions on screen to complete the setup.

URL

The URL of your Karakeep instance, for example https://karakeep.example.com.

API key

The Karakeep API key used to connect to your instance.

Verify SSL certificate

Whether to verify the SSL certificate of your Karakeep instance. Disable this if your instance uses a self-signed certificate.

Supported functionality

The Karakeep integration provides sensors for account statistics. The Karakeep server version is shown on the integration’s device page when your instance is running version 0.29.0 or later.

Sensors

For each config entry, the integration creates the following sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more]:

  • Bookmarks: Number of bookmarks in Karakeep.
  • Favorites: Number of favorite bookmarks.
  • Archived: Number of archived items.
  • Highlights: Number of highlights.
  • Lists: Number of lists.
  • Tags: Number of tags.

Data updates

The Karakeep integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] the statistics from your Karakeep instance every 5 minutes.

Troubleshooting

Cannot connect to Karakeep

Symptom: “Failed to connect”

During setup, Home Assistant cannot reach the Karakeep instance.

Resolution

  1. Make sure the URL includes http:// or https://.
  2. Make sure Home Assistant can reach the Karakeep instance over the network.
  3. Check whether a reverse proxy, firewall, or TLS certificate issue is blocking access from Home Assistant.

Authentication fails during setup

Symptom: “Invalid authentication”

During setup, Home Assistant reports that the provided API key is not valid.

Resolution

Verify that the API key is copied correctly and is still valid in Karakeep.

Removing the integration

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.

If you no longer use the API key, you can remove it from your Karakeep instance.