Obsidian icon

Obsidian

Interact with your Obsidian vault via the Local REST API

Overview

This node performs complex searches within an Obsidian vault using the Local REST API. It supports two types of complex queries: Dataview DQL and JSONLogic. Users can specify the query type and provide the corresponding query to retrieve data from their vault. This node is useful for advanced data retrieval scenarios, such as filtering and sorting notes based on metadata or content, enabling automation workflows that depend on specific search criteria within Obsidian.

Use Case Examples

  1. A user wants to retrieve all notes tagged with #task and sort them by modification time using a Dataview DQL query.
  2. A user needs to filter files matching certain patterns using a JSONLogic query to automate processing of specific markdown files.

Properties

Name Meaning
Query Type The type of complex query to perform, either Dataview DQL or JSONLogic.
Query The actual query string or JSON object to execute, depending on the selected query type.
Request Options Additional options for the request such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • result - The search results returned from the complex query execution.

Dependencies

  • An API key credential for authenticating with the Obsidian Local REST API.

Troubleshooting

  • Ensure the Obsidian Local REST API is running and accessible at the configured host and port.
  • Verify that the API key credential is correctly set and has the necessary permissions.
  • Check the query syntax for Dataview DQL or JSONLogic to avoid malformed queries.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
  • Proxy settings must be correctly configured if used, including authentication details if required.
  • Timeouts may occur if the server is slow or unresponsive; adjust the timeout setting accordingly.

Discussion