Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

The node interacts with an Obsidian Vault via its REST API, specifically to retrieve recent notes from the vault. This operation is useful for workflows that need to access or process the latest content added to an Obsidian Vault, such as syncing notes, generating summaries, or triggering actions based on new entries.

A practical example would be automating a daily digest of recently created or modified notes by fetching the most recent ones and then processing or sending them elsewhere.

Properties

Name Meaning
Limit The maximum number of recent notes to retrieve. Default is 5.

Output

The output contains a JSON array of note objects representing the most recent notes fetched from the Obsidian Vault. Each object corresponds to a note's data as returned by the API. The exact structure depends on the API response but typically includes note metadata and content fields.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs configuration of the API base URL (host) and optionally an API authentication token or credential.
  • The node uses HTTP requests to communicate with the API, expecting JSON responses.

Troubleshooting

  • Common issues:
    • Incorrect or missing API host URL can cause connection failures.
    • Authentication errors if required credentials are not provided or invalid.
    • Request limits or API rate limiting might restrict the number of notes retrieved.
  • Error messages:
    • Connection timeout or network errors indicate problems reaching the API endpoint.
    • Unauthorized or forbidden errors suggest missing or incorrect API credentials.
    • Invalid parameter errors may occur if the "Limit" property is set to an unsupported value.

To resolve these, verify the API endpoint URL, ensure valid credentials are configured, and confirm that the "Limit" value is within acceptable bounds.

Links and References

Discussion