Obsidian Api

Obsidian REST API (Advanced Features)

⚠️ Note: For standard vault operations, use the obsidian skill (faster, simpler).

This skill provides API-only features via the Obsidian Local REST API that require Obsidian's parser and index.

Prerequisites

REQUIRED: Install and configure the Obsidian Local REST API community plugin:

1. In Obsidian: Settings → Community Plugins → Browse
2. Search for "Local REST API" and install
3. Enable the plugin
4. Copy the API key from plugin settings
5. Note the server URL (default: https://127.0.0.1:27124)

No Python dependencies required - uses only Python standard library (urllib, ssl, json).

Environment Variables:

export OBSIDIAN_API_KEY=your_api_key_here
export OBSIDIAN_HOST=https://127.0.0.1:27124  # Optional, defaults to this

Store these in a .env file for persistence:

# .env or .env.obsidian
export OBSIDIAN_API_KEY=your_api_key_here
export OBSIDIAN_HOST=https://127.0.0.1:27124

Then load with: source .env

When to Use This Skill

Use ONLY for these API-specific features:

• Dataview queries - Complex DQL aggregation queries
• Periodic notes - Daily/weekly/monthly note management
• Patch operations - Insert content after specific heading or block reference
• JSONLogic queries - Advanced metadata filtering

Do NOT use for:

• Search - use obsidian skill (7x faster with ripgrep)
• Read/Write files - use obsidian skill (50x faster, direct filesystem)
• List files - use obsidian skill
• Append content - use obsidian skill
• Delete files - use obsidian skill

Default to the obsidian skill for all standard vault operations.

Vault Structure Awareness

• Main vault: Root directory contains all notes
• Slipbox: Located at _Slipbox/ within the vault
• All paths are relative to vault root
• Directories use trailing slashes: _Slipbox/, Projects/

Helper Scripts

All operations are performed through Python helper scripts that interact with the Obsidian REST API:

• scripts/obsidian_api.py - Core API wrapper (don't call directly)
• scripts/search_vault.py - Search notes by content or metadata
• scripts/read_note.py - Read one or more note files
• scripts/write_note.py - Create or update notes
• scripts/append_note.py - Append content to existing notes
• scripts/patch_note.py - Insert content relative to headings/blocks
• scripts/list_files.py - List files in vault or directory
• scripts/delete_note.py - Delete notes (use with caution)
• scripts/periodic_notes.py - Get daily/weekly/monthly notes
• scripts/recent_notes.py - Find recently modified notes

Common Operations

Search the Vault

Search all notes (including slipbox):

python ~/.claude/skills/obsidian/scripts/search_vault.py "search term" --context 100

Search only in slipbox:

python ~/.claude/skills/obsidian/scripts/search_vault.py "search term" --path "_Slipbox/"

Read Notes

Read a single note:

python ~/.claude/skills/obsidian/scripts/read_note.py "Note Title.md"

Read multiple notes:

python ~/.claude/skills/obsidian/scripts/read_note.py "Note 1.md" "Note 2.md" "Note 3.md"

Read from slipbox:

python ~/.claude/skills/obsidian/scripts/read_note.py "_Slipbox/concept.md"

Create or Update Notes

Create a new note:

python ~/.claude/skills/obsidian/scripts/write_note.py "New Note.md" --content "# New Note\n\nContent here"

Create in slipbox:

python ~/.claude/skills/obsidian/scripts/write_note.py "_Slipbox/new-concept.md" --content "# Concept\n\nDetails..."

Append to Notes

Add content to end of note:

python ~/.claude/skills/obsidian/scripts/append_note.py "Daily Note.md" --content "\n## New Section\n\nAdded content"

Insert Content at Specific Location

Insert after a heading:

python ~/.claude/skills/obsidian/scripts/patch_note.py "Note.md" \
  --content "New content" \
  --heading "Section Title"

Insert after a block reference:

python ~/.claude/skills/obsidian/scripts/patch_note.py "Note.md" \
  --content "New content" \
  --block "block-id"

List Files

List all files in vault:

python ~/.claude/skills/obsidian/scripts/list_files.py

List files in slipbox:

python ~/.claude/skills/obsidian/scripts/list_files.py --path "_Slipbox/"

List specific directory:

python ~/.claude/skills/obsidian/scripts/list_files.py --path "Projects/Active/"

Periodic Notes

Get today's daily note:

python ~/.claude/skills/obsidian/scripts/periodic_notes.py daily

Get this week's weekly note:

python ~/.claude/skills/obsidian/scripts/periodic_notes.py weekly

Get recent daily notes:

python ~/.claude/skills/obsidian/scripts/recent_notes.py daily --limit 7

Delete Notes

Delete a note (prompts for confirmation):

python ~/.claude/skills/obsidian/scripts/delete_note.py "Old Note.md"

Force delete without confirmation:

python ~/.claude/skills/obsidian/scripts/delete_note.py "Old Note.md" --force

Slipbox-Specific Workflows

The skill is aware that _Slipbox/ is special and contains your Zettelkasten/slip-box notes.

Search slipbox for concepts:

python ~/.claude/skills/obsidian/scripts/search_vault.py "emergence" --path "_Slipbox/" --context 200

Create new slipbox note:

python ~/.claude/skills/obsidian/scripts/write_note.py "_Slipbox/202501131045-emergence-in-systems.md" \
  --content "# Emergence in Systems\n\nEmergence occurs when...\n\n## References\n- [[complex-systems]]\n- [[self-organization]]"

List all slipbox notes:

python ~/.claude/skills/obsidian/scripts/list_files.py --path "_Slipbox/"

Integration with Other Skills

This skill works well with:

• slipbox-integration - Links slipbox notes into narrative projects
• narrative-inventory - Can read/write inventories to vault
• narrative-maps - Can store spatial maps in vault
• project-indexer - Can maintain project indexes in vault

Best Practices

1. Always check environment first - Use env-manager skill if API key is not set
2. Use relative paths - All paths are relative to vault root
3. Include file extensions - Always use .md for markdown files
4. Respect slipbox structure - Slipbox notes are in _Slipbox/
5. Search before creating - Check if note exists before creating new ones
6. Use descriptive titles - Especially for slipbox notes (e.g., 202501131045-concept-name.md)
7. Preserve links - Maintain [[wikilinks]] when modifying notes
8. Handle errors gracefully - API may fail if Obsidian is closed

Error Handling

Common issues:

• Connection refused: Obsidian is not running or REST API plugin is disabled
• 401 Unauthorized: OBSIDIANAPIKEY is incorrect or not set
• 404 Not Found: File path doesn't exist in vault
• SSL errors: Set OBSIDIAN_VERIFY_SSL=false if using self-signed cert

API Endpoints Reference

For transparency, here are the underlying REST API endpoints used:

| Operation | Endpoint | Method | |-----------|----------|--------| | List vault files | /vault/ | GET | | List directory | /vault/{path}/ | GET | | Read file | /vault/{filepath} | GET | | Create/Update | /vault/{filepath} | POST | | Patch content | /vault/{filepath} | PATCH | | Delete file | /vault/{filepath} | DELETE | | Simple search | /search/simple/ | POST | | Advanced search | /search/ | POST | | Get periodic note | /periodic/{period}/ | GET | | Recent periodic | /periodic/{period}/recent | GET |

All requests require Authorization: Bearer {API_KEY} header.

Security Notes

• API key grants full vault access - treat as sensitive credential
• Store in environment variables, not in code
• Default server uses self-signed SSL certificate
• API only accessible on localhost by default
• No authentication beyond API key

Troubleshooting

1. Skill not working: Check if REST API plugin is enabled in Obsidian
2. Can't find notes: Verify paths are relative to vault root, not filesystem
3. SSL errors: Add --no-verify-ssl flag to scripts if needed
4. Empty results: Obsidian may need to finish indexing vault
5. Changes not visible: Obsidian auto-reloads, but may need manual refresh

Advanced Usage

Complex Searches with JSONLogic

The API supports JSONLogic queries for advanced filtering:

# Example: Find notes modified in last 7 days with tag #important
query = {
    "and": [
        {">=": [{"var": "mtime"}, 1704672000]},
        {"in": ["#important", {"var": "tags"}]}
    ]
}

See scripts source code for implementation details.

Batch Operations

Read multiple files at once:

python ~/.claude/skills/obsidian/scripts/read_note.py \
  "Note1.md" "Note2.md" "Note3.md" \
  --format json

Working with Templates

Store templates in vault and copy when creating notes:

# Read template
template=$(python ~/.claude/skills/obsidian/scripts/read_note.py "Templates/Note Template.md")

# Create note from template
python ~/.claude/skills/obsidian/scripts/write_note.py "New Note.md" --content "$template"

Script Output Formats

Most scripts support --format flag:

• text (default) - Human-readable output
• json - Machine-readable JSON for scripting
• markdown - Formatted markdown

Example:

python ~/.claude/skills/obsidian/scripts/search_vault.py "term" --format json | jq

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: scott2b
• Source: scott2b/claude-skills
• License: Apache-2.0

Install and usage instructions live in the source repository linked above.