Actions11
- Vault Actions
- Search Actions
- Periodic Note Actions
- Recent Actions
Overview
This node performs a simple text search within an Obsidian vault using the Local REST API. It allows users to input a search query and specify how much context around the matching string should be returned. This is useful for quickly finding relevant notes or content within the vault based on a keyword or phrase.
Use Case Examples
- Searching for a specific term or phrase in your Obsidian vault to locate related notes.
- Retrieving snippets of text around a keyword to understand the context in which it appears.
Properties
| Name | Meaning |
|---|---|
| Query | The text string to search for within the vault. This is a required input. |
| Context Length | The amount of surrounding text to return around the matching search string, providing context for the search result. |
| Request Options | Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration. |
Output
JSON
results- Array of search results containing matching strings and their context from the vault.
Dependencies
- Requires an API key credential to authenticate 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 credentials (protocol, host, port) are correctly set in the node credentials.
- If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
- Check proxy settings if requests are failing due to network restrictions.
- Adjust timeout settings if the server response is slow or timing out.
Links
- Obsidian Local REST API Documentation - Official documentation for the Obsidian Local REST API used by this node.