Obsidian Vault REST APIInstall

Overview

This node interacts with an Obsidian Vault via its REST API, specifically to retrieve a note by its path. It is useful when you want to programmatically access the content or metadata of a specific note stored in an Obsidian Vault. For example, you might use this node to fetch a note's content for further processing, integration with other tools, or automated backups.

Properties

Output

The node outputs JSON data representing the requested note. This typically includes the note's content and possibly metadata such as creation date, modification date, and other relevant attributes provided by the Obsidian Vault API. There is no indication that binary data is output by this node.

Dependencies

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

Troubleshooting

• Common issues:
  • Incorrect or missing note path will result in failure to retrieve the note.
  • Network connectivity problems or incorrect API host configuration can cause request failures.
  • Authentication errors if the API key or token is invalid or missing.
• Error messages:
  • "Note not found" or similar indicates the specified path does not exist in the vault.
  • "Unauthorized" or "Authentication failed" suggests issues with API credentials.
  • Timeout or connection errors indicate network or server availability problems.
• Resolutions:
  • Verify the exact path of the note in the vault.
  • Check API host URL and credentials are correctly set.
  • Ensure the API service is running and accessible from n8n.

Links and References

• Obsidian Vault REST API Documentation (generic reference)
• n8n OpenAPI Node Integration