Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API
Join our community

Actions23

Overview

This node interacts with an Obsidian Vault REST API to retrieve tags associated with agents. Specifically, the "Get Tags" operation under the "Agent" resource fetches tags that are used to categorize or label agents within the system. This can be useful for filtering, organizing, or reporting on agents based on their tags.

Common scenarios include:

  • Retrieving all tags that have a minimum number of associated agents.
  • Including nested tags in the results to get hierarchical tag structures.
  • Choosing between a flat list of tags or a hierarchical representation.

Practical example:

  • A user wants to get all tags assigned to agents where each tag is used by at least 5 agents, including nested tags, and receive the tags in a hierarchical format to understand parent-child relationships.

Properties

Name Meaning
Min Count Minimum number of agents that must have a tag for it to be included in the results.
Include Nested Whether to include nested (child) tags in the results.
Format The format of the returned tags: either "Flat" (a simple list) or "Hierarchical" (nested structure).

Output

The output JSON contains the list of tags retrieved from the Obsidian Vault REST API according to the specified parameters. The structure depends on the chosen format:

  • Flat: An array of tag objects without hierarchy.
  • Hierarchical: A nested structure representing parent and child tags.

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.
  • Optionally requires an API authentication token or key configured in n8n credentials to authorize requests.

Troubleshooting

  • Common issues:
    • Incorrect or missing API host configuration may cause connection failures.
    • Insufficient permissions or missing API authentication can result in authorization errors.
    • Setting min_count too high might return no tags if none meet the threshold.
  • Error messages:
    • Connection errors: Verify the API host URL and network connectivity.
    • Authorization errors: Ensure valid API credentials are provided.
    • Empty results: Adjust min_count or check if tags exist in the vault.

Links and References

Discussion