Overview
Add Obsidian to any ModuleX agent or workflow. Read, create, update, search, and delete notes in your Obsidian vault via the Obsidian Local REST API plugin. Manage periodic notes, list and execute commands, work with the active file, and patch content at specific headings, block references, or frontmatter fields. The plugin runs locally inside your Obsidian app and is reachable at abase_url you pass on every call (default https://127.0.0.1:27124). Because the plugin serves a self-signed TLS certificate, the HTTP client does not verify the certificate chain.
Authentication
API Key Authentication
Authenticate using the API key from the Obsidian Local REST API pluginStep 1
Step 2
Step 3
Step 4
Step 5
Required Credentials
Available Actions
list_files — List files and directories in your Obsidian vault.
list_files — List files and directories in your Obsidian vault.
Parameters
Response
get_note — Retrieve the content of a note from your Obsidian vault.
get_note — Retrieve the content of a note from your Obsidian vault.
Parameters
Response
create_note — Create or replace a note in your Obsidian vault.
create_note — Create or replace a note in your Obsidian vault.
append_note — Append content to an existing note in your Obsidian vault.
append_note — Append content to an existing note in your Obsidian vault.
patch_note — Insert or replace content at a specific heading, block reference, or frontmatter field in a note.
patch_note — Insert or replace content at a specific heading, block reference, or frontmatter field in a note.
Parameters
Response
delete_note — Delete a note from your Obsidian vault.
delete_note — Delete a note from your Obsidian vault.
Parameters
Response
search — Search for text across notes in your Obsidian vault.
search — Search for text across notes in your Obsidian vault.
get_active — Retrieve the content of the currently active file in Obsidian.
get_active — Retrieve the content of the currently active file in Obsidian.
Parameters
Response
append_active — Append content to the currently active file in Obsidian.
append_active — Append content to the currently active file in Obsidian.
Parameters
Response
patch_active — Insert or replace content at a specific heading, block reference, or frontmatter field in the active file.
patch_active — Insert or replace content at a specific heading, block reference, or frontmatter field in the active file.
Parameters
Response
open_file — Open a file in the Obsidian UI (creates the file if it does not exist).
open_file — Open a file in the Obsidian UI (creates the file if it does not exist).
list_commands — List all available commands in Obsidian.
list_commands — List all available commands in Obsidian.
Parameters
Response
get_periodic_note — Retrieve the current periodic note (daily, weekly, monthly, quarterly, or yearly).
get_periodic_note — Retrieve the current periodic note (daily, weekly, monthly, quarterly, or yearly).
Parameters
Response
append_periodic_note — Append content to the current periodic note (daily, weekly, monthly, quarterly, or yearly). Creates the note if it does not exist.
append_periodic_note — Append content to the current periodic note (daily, weekly, monthly, quarterly, or yearly). Creates the note if it does not exist.
Limits & Quotas
- The Local REST API runs on the user’s own machine, so throughput is bound only by the local Obsidian instance; there is no vendor rate limit.
base_urlmust be reachable from where the runtime executes (typically the same host). The defaulthttps://127.0.0.1:27124only works for a co-located process.- Error model: non-2xx responses and timeouts are caught and
returned as
success=False+errorrather than raising.