obsidian-local-rest-api

Manage Obsidian notes via the Local REST API using a Python CLI client.

2|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/Shana-AE/.shanaae-configs --skill obsidian-local-rest-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-local-rest-api
Source: https://github.com/Shana-AE/.shanaae-configs/tree/main/ai/skills/local/obsidian-local-rest-api
Command: npx skills add https://github.com/Shana-AE/.shanaae-configs --skill obsidian-local-rest-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables programmatic access to your Obsidian vaults through the Local REST API, allowing you to read, write, list, search, and delete notes without manual UI interaction.

Core Features & Use Cases

  • Read, list, update, and delete notes via a Python CLI client.
  • Search notes and manage daily notes to automate vault workflows and integrate Obsidian data with other tools.
  • Use cases include automated vault maintenance, batch note updates, and CI/pipeline integrations that manage Obsidian data.

Quick Start

Install the Python client, set OBSIDIAN_API_KEY, and run python3 client.py read 'Folder/Note.md' to verify connectivity.

Frequently Asked Questions about obsidian-local-rest-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate reading and writing Obsidian notes from an external script?

You can automate reading and writing Obsidian notes by using a Python CLI client to interact with the Obsidian Local REST API. This allows external scripts to programmatically manage vault content without manual UI interaction.

What do I need to connect Python to my Obsidian vault?

To connect Python to your Obsidian vault, you need Python 3 with the provided client.py, the OBSIDIAN_API_KEY environment variable set, and optionally OBSIDIAN_BASE_URL and OBSIDIAN_VERIFY_SSL configured for your Local REST API connection.

Can I search and delete notes in my Obsidian vault via an automation pipeline?

Yes, you can search and delete notes in your Obsidian vault via an automation pipeline. The client supports listing, searching, and deleting notes to automate vault workflows and integrate Obsidian data with other tools.

Does the Obsidian Local REST API support batch note updates for CI pipelines?

Yes, the Obsidian Local REST API supports batch note updates for CI pipelines. The skill is designed for automated vault maintenance and CI/pipeline integrations that programmatically manage Obsidian data.

How do I verify connectivity to the Obsidian Local REST API?

To verify connectivity to the Obsidian Local REST API, install the Python client, set your OBSIDIAN_API_KEY, and run python3 client.py read 'Folder/Note.md' to successfully retrieve a note from your vault.