Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API
Join our community

Actions23

Overview

The "Search Vault" operation in the Vault resource allows users to perform search queries within an Obsidian Vault via its REST API. This node is useful for retrieving notes, files, or metadata that match specific search criteria inside a vault. Typical use cases include automating content retrieval based on keywords, filtering files by tags or paths, and integrating vault data into workflows for further processing or analysis.

For example, you might use this node to:

  • Search for all notes containing a particular keyword.
  • Filter files by filename or tags.
  • Limit search results to a specific folder path within the vault.

Properties

Name Meaning
Query The search query string to find matching content in the vault.
Scope Comma-separated list specifying where to search: content, filename, tags.
Path Filter A filter string to limit search results to files under a specific path or folder.

Output

The node outputs JSON data representing the search results returned from the Obsidian Vault REST API. This typically includes matched files or notes with their metadata such as filenames, paths, tags, and possibly content snippets depending on the API response.

If the node supports binary data output (not explicitly shown here), it would represent file contents or attachments retrieved from the vault.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials or node settings.
  • May require an API authentication token or key (configured generically as an API key credential).
  • Depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Empty results: Ensure the query string is correctly formatted and matches existing content. Verify the scope and path filters are appropriate.
  • Connection errors: Check the API host URL and network connectivity. Confirm that any required authentication tokens are valid and included.
  • Invalid parameters: Make sure the scope uses valid values (content, filename, tags) separated by commas without typos.
  • API errors: If the API returns errors, review the error message for hints (e.g., unauthorized, not found) and adjust credentials or request parameters accordingly.

Links and References

Discussion