API Reference

Complete API reference for Obsidian SDK services.

Services

Files & Vault

• Vault — Vault configuration and management
• File — File read, write, and operations
• Daily — Daily notes creation and management
• Templates — Note template operations
• Workspace — Obsidian workspace control
• Search — Full-text search functionality
• Tags — Tag management and operations
• Outline — Document outline/navigation

Note Relationships

• Backlinks — View and manage incoming links
• Links — Internal link operations

Content & Metadata

• Properties — Frontmatter and note properties
• Aliases — Note alias management
• Tasks — Task and todo management
• Random — Random note selection

Platform Configuration

• Plugins — Plugin management
• Themes — Theme installation and management
• Snippets — CSS snippet management
• Sync — Obsidian Sync configuration
• Publish — Obsidian Publish site management

System & Utilities

• History — File history and recovery
• Diff — Compare file versions
• Dev — Developer tools and debugging
• Misc — Version, word count, app control

Base URL

All API endpoints use the base URL:

http://localhost:3000/api/

Quick Start

List all files in a vault:

curl "http://localhost:3000/api/files?vault=youtube"

Read a specific file:

curl "http://localhost:3000/api/file/read?file=Notes.md&vault=youtube"

Search for notes:

curl "http://localhost:3000/api/search?q=project&vault=youtube"

Common Parameters

Most endpoints support these parameters:

Response Format

All responses follow a consistent format:

{
  "success": true,
  "data": {
    "type": "message|list|kv",
    "data": "..."
  }
}

Getting Help

• Quick Start Guide - Get started in 2 minutes
• Files & Vault - File operations
• Search - Full-text search
• Dev Tools - Developer utilities