Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API
Join our community

Actions23

Overview

This node allows users to create a new note in an Obsidian Vault via its REST API. It is useful for automating the creation of markdown notes with optional front matter metadata and content, directly from workflows. Typical use cases include generating meeting notes, daily journals, or automated documentation based on external data sources.

Properties

Name Meaning
Path The file path (including filename) where the new note will be created inside the vault.
Front Matter JSON object representing the YAML front matter metadata to prepend to the note.
Content The main textual content of the note in markdown format.

Output

The node outputs JSON data representing the response from the Obsidian Vault REST API after creating the note. This typically includes confirmation details such as the created note's path and any metadata returned by the API. There is no binary output.

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 depending on the vault’s security setup.

Troubleshooting

  • Common issues:
    • Incorrect or missing Path can cause the note creation to fail.
    • Malformed JSON in Front Matter may lead to parsing errors.
    • Network connectivity or incorrect API host configuration can prevent communication with the vault.
  • Error messages:
    • "Invalid path" or "File already exists" indicates issues with the specified note path.
    • "Malformed JSON" points to errors in the front matter input.
    • Authentication errors suggest missing or invalid API credentials.
  • Resolutions:
    • Verify the path string is valid and does not conflict with existing files.
    • Ensure front matter JSON is well-formed.
    • Check API host URL and credentials are correctly set up in n8n.

Links and References

Discussion