Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

This node interacts with an Obsidian Vault REST API to retrieve backlinks for a specified note. Backlinks are references from other notes that link back to the given note, which is useful for understanding relationships and connections within your vault.

Common scenarios include:

  • Analyzing how notes interconnect in a knowledge base.
  • Generating lists of related notes for navigation or content aggregation.
  • Building custom dashboards or reports based on note references.

For example, you might use this node to fetch all notes linking to a particular project note, optionally including mentions and tags, to get a comprehensive view of related content.

Properties

Name Meaning
Note Path The path or identifier of the note for which to retrieve backlinks.
Include Mentions Whether to include mentions (textual references) in the backlink results. Options: true or false.
Include Tags Whether to include tags associated with backlinks. Options: true or false.

Output

The node outputs JSON data containing the backlinks information for the specified note. This includes details about each backlink, potentially enriched with mentions and tags depending on the input properties.

The exact structure depends on the API response but generally includes:

  • A list of notes linking back to the specified note.
  • Metadata such as mention contexts if included.
  • Tag information if requested.

No binary data output is indicated.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials.
  • Optionally requires an API authentication token or key (configured via n8n credentials).
  • The node uses standard HTTP requests with JSON payloads.

Troubleshooting

  • Missing or incorrect Note Path: Ensure the "Note Path" property is correctly set; otherwise, the API may return errors or empty results.
  • API connectivity issues: Verify the API host URL and network accessibility.
  • Authentication failures: Confirm that the required API credentials are properly configured.
  • Unexpected empty results: Check if the note actually has backlinks or if filters like "Include Mentions" and "Include Tags" affect the output.

Links and References

Discussion