obsidian

# Open a vault
obsidian://open?vault=MyVault
 
# Open a specific file
obsidian://open?vault=MyVault&file=Notes/MyNote
 
# Create a new note
obsidian://new?vault=MyVault&name=NewNote&content=Hello
 
# Search the vault
obsidian://search?vault=MyVault&query=keyword
 
# Open daily note
obsidian://daily?vault=MyVault

What do you need to do?
├── Automate Obsidian from external tools?
│   ├── Simple open/create operations?
│   │   └── Use: Native obsidian:// URI scheme
│   ├── Complex automation (append, prepend, commands)?
│   │   └── Use: Advanced URI plugin
│   └── Full programmatic access?
│       └── Use: Local REST API plugin
├── Build a plugin for Obsidian?
│   └── See: Plugin Development section
├── Work with vault files directly?
│   └── Use: obsidian-cli or direct file operations
├── Extend markdown syntax?
│   └── See: Markdown Extensions section
└── Query notes and metadata?
    └── Use: Local REST API or Dataview plugin

my-plugin/
├── main.ts           # Plugin entry point
├── manifest.json     # Plugin metadata
├── package.json      # npm dependencies
├── styles.css        # Optional styles
├── tsconfig.json     # TypeScript config
└── esbuild.config.mjs # Build config

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "minAppVersion": "1.0.0",
  "description": "A sample plugin for Obsidian",
  "author": "Your Name",
  "authorUrl": "https://github.com/username",
  "isDesktopOnly": false
}

import { Plugin, Notice, MarkdownView } from 'obsidian';
 
export default class MyPlugin extends Plugin {
  async onload() {
    console.log('Loading plugin');
 
    // Register a command
    this.addCommand({
      id: 'my-command',
      name: 'My Command',
      callback: () => {
        new Notice('Hello from my plugin!');
      }
    });
 
    // Register editor command
    this.addCommand({
      id: 'my-editor-command',
      name: 'Insert Text',
      editorCallback: (editor, view: MarkdownView) => {
        editor.replaceSelection('Inserted text');
      }
    });
 
    // Register event listener
    this.registerEvent(
      this.app.workspace.on('file-open', (file) => {
        if (file) {
          console.log('Opened:', file.path);
        }
      })
    );
  }
 
  onunload() {
    console.log('Unloading plugin');
  }
}

// onload() - Called when plugin is enabled
async onload() {
  // Initialize UI components
  // Register event handlers
  // Set up commands
  // Load settings
}
 
// onunload() - Called when plugin is disabled
onunload() {
  // Cleanup is mostly automatic
  // Custom cleanup for external resources
}

# Using API key header
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://127.0.0.1:27124/vault/

# List all files
GET /vault/
 
# Get file content
GET /vault/{path-to-file}
 
# Create/Update file
PUT /vault/{path-to-file}
Content-Type: text/markdown
Body: File content here
 
# Delete file
DELETE /vault/{path-to-file}
 
# Search vault
POST /search/simple/
Content-Type: application/json
Body: {"query": "search term"}
 
# Execute command
POST /commands/{command-id}
 
# Get active file
GET /active/
 
# Open file in Obsidian
POST /open/{path-to-file}

import requests
 
class ObsidianAPI:
    def __init__(self, api_key, base_url="https://127.0.0.1:27124"):
        self.base_url = base_url
        self.headers = {
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json"
        }
        self.session = requests.Session()
        self.session.verify = False  # Self-signed cert
 
    def list_files(self, path=""):
        response = self.session.get(
            f"{self.base_url}/vault/{path}",
            headers=self.headers
        )
        return response.json()
 
    def read_file(self, path):
        response = self.session.get(
            f"{self.base_url}/vault/{path}",
            headers=self.headers
        )
        return response.text
 
    def write_file(self, path, content):
        response = self.session.put(
            f"{self.base_url}/vault/{path}",
            headers={**self.headers, "Content-Type": "text/markdown"},
            data=content.encode('utf-8')
        )
        return response.status_code == 204
 
    def search(self, query):
        response = self.session.post(
            f"{self.base_url}/search/simple/",
            headers=self.headers,
            json={"query": query}
        )
        return response.json()

[[Note Name]]                    # Link to note
[[Note Name|Display Text]]       # Link with alias
[[Note Name#Heading]]            # Link to heading
[[Note Name#^block-id]]          # Link to block
[[Note Name#^block-id|alias]]    # Block link with alias

![[Note Name]]                   # Embed entire note
![[Note Name#Heading]]           # Embed section
![[Note Name#^block-id]]         # Embed block
![[image.png]]                   # Embed image
![[image.png|300]]               # Embed with width
![[image.png|300x200]]           # Embed with dimensions
![[audio.mp3]]                   # Embed audio
![[video.mp4]]                   # Embed video
![[document.pdf]]                # Embed PDF

> [!note] Title
> Content here
 
> [!warning] Caution
> Important warning message
 
> [!tip]+ Expandable (default open)
> Click to collapse
 
> [!info]- Collapsed (default closed)
> Click to expand
 
# Available types:
# note, abstract, summary, tldr, info, todo, tip, hint,
# important, success, check, done, question, help, faq,
# warning, caution, attention, failure, fail, missing,
# danger, error, bug, example, quote, cite

This is a paragraph. ^block-id
 
# Reference this block from another note:
[[Note#^block-id]]

#tag
#nested/tag
#tag-with-dashes

---
title: My Note
date: 2024-01-15
tags:
  - tag1
  - tag2
aliases:
  - alternate name
cssclass: custom-class
---
 
# Note content starts here

%%This is a comment that won't render%%
 
%%
Multi-line
comment
%%

Inline: $E = mc^2$
 
Block:
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$