Obsidian API icon

Obsidian API

Run official Obsidian CLI commands through the Obsidian API Docker service

Actions19

Property → Read

AI-generated

Summary

Read a named frontmatter property from a note by running Obsidian’s property:read command for the specified path and property name.

Inputs

  • Path (required) — Note path, such as Inbox/Note.md.
  • Name — Frontmatter/property name to read, such as tags, date, or description. The UI does not mark it required, but the command includes it when non-empty.
  • Timeout Seconds — Command timeout in seconds; defaults to 60.
  • Vault — Vault name or path. Overrides the credential’s default vault when provided.

Output shape

A single item with a content string containing the command’s stdout.

The result may also include stderr when present or timed_out when true. If the command fails and Continue On Fail is enabled, the item contains ok: false, the operation, path, property name, and error message.

Links

Discussion