Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API
Join our community

Actions23

Overview

This node interacts with an Obsidian Vault via its REST API, specifically to retrieve notes related to a given note path. The "Get Related Notes" operation fetches notes that are connected through tags or links to the specified note. This is useful for users who want to explore or analyze relationships between notes in their vault, such as finding all notes linked to a particular topic or tag.

Practical examples include:

  • Automatically gathering all notes related to a project by specifying the main note's path.
  • Creating dashboards or summaries that show connections between notes based on shared tags or links.
  • Enhancing workflows by dynamically fetching related content for review or processing.

Properties

Name Meaning
Path The file path of the note within the vault for which related notes should be retrieved.
On Criteria to find related notes; a comma-separated list including tags and/or links.
Limit Maximum number of related notes to return (default is 10).

Output

The node outputs JSON data representing the related notes found for the specified note path. Each item in the output corresponds to a related note, typically including metadata such as note identifiers, titles, paths, and possibly snippets or other relevant fields depending on the API response.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs configuration of an API host URL and optionally an API authentication token or key.
  • The node expects the vault API to support query parameters for filtering related notes by tags or links and limiting the number of results.

Troubleshooting

  • Common issues:

    • Incorrect or missing note path may result in no related notes found or errors.
    • Improperly formatted "On" parameter (e.g., misspelled criteria) might cause the API to ignore the filter or return unexpected results.
    • API connectivity problems due to incorrect host URL or missing credentials.

  • Error messages:

    • Errors indicating failure to connect to the API usually mean the base URL or credentials are misconfigured.
    • Validation errors about required parameters typically point to missing "Path".

  • Resolutions:

    • Verify the note path exists in the vault and is correctly specified.
    • Ensure the "On" field contains valid values: "tags", "links", or both separated by commas.
    • Check API host and authentication settings in the node credentials.

Links and References

Discussion