Actions23
- Files Actions
- Notes Actions
- Metadata Actions
- Vault Actions
- Agent Actions
Overview
This node interacts with an Obsidian Vault via its REST API, specifically allowing users to retrieve files stored in the vault. The "Get File" operation fetches a file by specifying its URL-encoded path relative to the vault root. This is useful for workflows that need to access or process content from an Obsidian Vault programmatically, such as backing up notes, analyzing markdown files, or integrating vault content into other systems.
Example use cases:
- Automatically retrieving a note file to analyze or transform its content.
- Downloading attachments or resources stored within the vault.
- Integrating Obsidian Vault content into external applications or dashboards.
Properties
| Name | Meaning |
|---|---|
| Path | URL-encoded vault-relative path to the file you want to retrieve. This must be provided and specifies the exact location of the file inside the vault. |
Output
The node outputs the retrieved file data in the json output field. The structure typically includes metadata about the file and its contents as returned by the Obsidian Vault REST API. If the file is binary (e.g., images or other media), the node may also provide binary data output representing the file content.
Dependencies
- Requires access to an Obsidian Vault REST API endpoint.
- Needs configuration of credentials containing the host URL and an API authentication token to authorize requests.
- The node uses standard HTTP headers to communicate with the API, expecting JSON responses.
Troubleshooting
- File Not Found: If the specified path does not exist or is incorrect, the API will likely return an error indicating the file was not found. Verify the path is URL-encoded and correctly relative to the vault root.
- Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key or token is correctly configured in the node credentials.
- Network Issues: Connectivity problems to the vault server will prevent file retrieval. Check network settings and the availability of the vault API endpoint.
- Invalid Path Encoding: The path must be URL-encoded; otherwise, the API may reject the request or fail to locate the file.
Links and References
- Obsidian Vault REST API Documentation (example link, replace with actual if available)
- n8n Documentation on Creating Custom Nodes
- URL Encoding Reference