Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

This node interacts with an Obsidian Vault via its REST API, specifically allowing users to update the content of a file within the vault. It is useful in scenarios where you want to programmatically modify notes or documents stored in an Obsidian Vault, such as automating updates, syncing content from other sources, or batch editing files.

For example, you could use this node to update a markdown note's content based on data processed earlier in your workflow, enabling dynamic documentation or note-taking automation.

Properties

Name Meaning
Path The path to the file within the Obsidian Vault that you want to update.
Content The new content to write into the specified file. This replaces the existing file data.

Output

The node outputs JSON data representing the response from the Obsidian Vault REST API after attempting to update the file. This typically includes confirmation of the update or details about the updated file. The output does not include binary data.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials (an API authentication token or similar).
  • The node uses HTTP requests with JSON payloads to communicate with the API.

Troubleshooting

  • Common issues:

    • Incorrect file path may cause the update to fail because the target file cannot be found.
    • Missing or invalid API host configuration will prevent communication with the Obsidian Vault.
    • Insufficient permissions or authentication errors if the API key/token is missing or invalid.
  • Error messages:

    • "File not found" or similar indicates the specified path does not exist in the vault.
    • "Unauthorized" or "Authentication failed" suggests problems with API credentials.
    • Network errors indicate connectivity issues with the configured API host.

To resolve these, verify the file path, ensure correct API host and credentials are set up, and check network connectivity.

Links and References

Discussion