Obsidian API icon

Obsidian API

Run official Obsidian CLI commands through the Obsidian API Docker service

Actions19

Search → Search

AI-generated

Summary

Searches the Obsidian vault using the required query and selected output format. The node sends the CLI search command through the Obsidian API, applying the configured vault and timeout, and returns parsed JSON output when available or { "ok": true } otherwise.

Inputs

  • Query (required) — Search query passed to the Obsidian CLI as query=<value>.
  • Format — Output format: Text (text, default) or JSON (json), passed to the CLI as format=<value>.
  • Timeout Seconds — Command timeout in seconds; defaults to 60.
  • Vault — Vault name or path. Overrides the credential’s default vault and is sent with the command.

Output shape

One n8n item per input item, containing the parsed JSON search result when stdout can be parsed as JSON, or { "ok": true } when it cannot.

A nonzero CLI exit code causes an error. With Continue On Fail enabled, the item instead contains { "ok": false, "error": "…" }. Nonempty stderr and a timed_out flag are included in successful output when present.

Links

Discussion