Obsidian Local Rest API
A secure REST API and Model Context Protocol (MCP) server for your vault.
Installation
npx obsidian-local-rest-apiAsk AI about Obsidian Local Rest API
Powered by Claude · Grounded in docs
I know everything about Obsidian Local Rest API. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
Local REST API for Obsidian
See our interactive docs: https://coddingtonbear.github.io/obsidian-local-rest-api/
Have you ever needed to automate interacting with your notes? This plugin gives Obsidian a REST API you can interact with your notes from other tools so you can automate what you need to automate.
This plugin provides a secure HTTPS interface gated behind api key authentication that allows you to:
- Read, create, update or delete existing notes. There's even a
PATCHHTTP method for inserting content into a particular section of a note. - List notes stored in your vault.
- Create and fetch periodic notes.
- Execute commands and list what commands are available.
- Full Canvas support - Read and modify Canvas files (nodes and edges).
- Periodic notes configuration - Get periodic notes settings and recent notes.
This is particularly useful if you need to interact with Obsidian from a browser extension like Obsidian Web.
Installation
Via BRAT (Recommended)
- Install the BRAT plugin from Obsidian Community Plugins
- Open BRAT settings and click "Add Beta plugin"
- Enter:
ArtiPyHeart/obsidian-local-rest-api - Click "Add Plugin" and enable it
Manual Installation
- Download the latest release from Releases
- Extract to your vault's
.obsidian/plugins/obsidian-local-rest-api/folder - Reload Obsidian and enable the plugin
MCP Server
For AI integration (Claude, etc.), use our MCP server: obsidian-api-mcp
uvx obsidian-api-mcp
Credits
This was inspired by Vinzent03's advanced-uri plugin with hopes of expanding the automation options beyond the limitations of custom URL schemes.
