Immich icon

Immich

Interact with Immich, a self-hosted photo and video management solution

Overview

This node interacts with the Immich API to perform a smart search for photo and video assets based on a natural language query and optional filters such as city, country, camera make, model, and state. It is useful for users who want to find specific media assets quickly by describing what they are looking for in natural language, for example, searching for "beach sunset" or "birthday party" photos.

Use Case Examples

  1. A user wants to find all photos taken at a beach during sunset, so they input the query "beach sunset" and optionally filter by city or country.
  2. A user searches for photos taken with a specific camera make and model by providing the make and model fields along with the query.

Properties

Name Meaning
Query Natural language search query to find assets (e.g., "beach sunset", "birthday party")
Additional Fields Optional filters to narrow down the search results, including city, country, camera make, model, and state
Request Options Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout

Output

JSON

  • results
    • ``
      * id - Unique identifier of the asset
      * url - URL to access the asset
      * metadata - Metadata information about the asset such as location, camera details, and timestamps

Dependencies

  • Immich API with an API key credential

Troubleshooting

  • Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
  • If the search query returns no results, verify the query syntax and filter values are correct and relevant to the stored assets.
  • Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting if needed.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this should be used cautiously.

Links

  • Immich API Documentation - Official API documentation for Immich, useful for understanding available endpoints and parameters.

Discussion