Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

The "Update Note" operation in the Notes resource allows users to modify an existing note within an Obsidian Vault via its REST API. This node is useful for workflows that need to programmatically update note content or metadata, such as automating documentation updates, syncing notes from other sources, or batch editing notes based on external triggers.

For example, you could use this node to update a meeting note with new agenda items or to append additional information to a project note automatically after a task completes.

Properties

Name Meaning
Path The file path of the note to update within the vault. This identifies which note to modify.
Front Matter JSON object representing the YAML front matter metadata of the note. Used to update or add metadata fields.
Content The main textual content of the note. This replaces the existing content of the note.

Output

The node outputs JSON data representing the response from the Obsidian Vault REST API after updating the note. This typically includes confirmation of the update and may contain the updated note's details.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials or environment variables.
  • An API key or authentication token may be required depending on the API setup (not explicitly shown in the code but implied by the credential configuration).

Troubleshooting

  • Invalid Path Error: If the specified note path does not exist, the API will likely return an error. Verify the path is correct and the note exists.
  • Malformed Front Matter: Providing invalid JSON in the Front Matter property can cause parsing errors. Ensure the JSON is well-formed.
  • Authentication Failures: Missing or incorrect API credentials will prevent successful requests. Confirm that the API host and authentication tokens are correctly set.
  • Empty Content: Updating a note with empty content might overwrite the note unintentionally. Double-check the content before sending.

Links and References

Discussion