Obsidian

Obsidian is a local-first knowledge base and note-taking app built on plain Markdown files. Obsidian itself does not publish a hosted SaaS API; programmatic access is provided through (1) the in-app Plugin API for community plugins, (2) the community-built Local REST API plugin that exposes vault operations over localhost HTTPS, and (3) optional paid add-on services Obsidian Sync and Obsidian Publish.

4 APIs 0 Features

ProductivityKnowledge ManagementMarkdownNotesLocal-First

APIs

Obsidian Plugin API

In-app TypeScript/JavaScript Plugin API for building Obsidian plugins. Plugins access the Vault, Workspace, MetadataCache, file system, command palette, settings, editor, and Ma...

Obsidian Local REST API

Community-built plugin (by @coddingtonbear) that exposes the Obsidian vault over a local HTTPS REST API on port 27124. Endpoint groups include Vault file CRUD, Active File, Peri...

Obsidian Sync

Paid managed service that syncs an Obsidian vault across devices with end-to-end encryption, version history, and shared-vault collaboration. Not exposed as a public REST API; i...

Obsidian Publish

Paid managed service that publishes selected notes from an Obsidian vault as a public website with graph view, full-text search, and customizable themes. Not exposed as a public...

Resources

Sources

aid: obsidian
url: https://raw.githubusercontent.com/api-evangelist/obsidian/refs/heads/main/apis.yml
name: Obsidian
x-type: company
description: >-
  Obsidian is a local-first knowledge base and note-taking app built on plain Markdown files. Obsidian itself does not publish a hosted SaaS API; programmatic access is provided through (1) the in-app Plugin API for community plugins, (2) the community-built Local REST API plugin that exposes vault operations over localhost HTTPS, and (3) optional paid add-on services Obsidian Sync and Obsidian Publish.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
  - Productivity
  - Knowledge Management
  - Markdown
  - Notes
  - Local-First
created: '2026-05-08'
modified: '2026-05-08'
specificationVersion: '0.19'
apis:
  - aid: obsidian:obsidian-plugin-api
    name: Obsidian Plugin API
    tags:
      - Plugins
      - Extensions
      - SDK
    image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://docs.obsidian.md/Home
    baseURL: local
    properties:
      - url: https://docs.obsidian.md/Home
        type: Documentation
      - url: https://github.com/obsidianmd/obsidian-api
        type: SDK
      - url: https://github.com/obsidianmd/obsidian-sample-plugin
        type: Sample
    description: >-
      In-app TypeScript/JavaScript Plugin API for building Obsidian plugins. Plugins access the Vault, Workspace, MetadataCache, file system, command palette, settings, editor, and Markdown post-processing. Distributed as community plugins via the Obsidian community plugin browser.
  - aid: obsidian:obsidian-local-rest-api
    name: Obsidian Local REST API
    tags:
      - Local API
      - REST
      - Vault
      - Community Plugin
    image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://github.com/coddingtonbear/obsidian-local-rest-api
    baseURL: https://127.0.0.1:27124
    properties:
      - url: https://github.com/coddingtonbear/obsidian-local-rest-api
        type: Documentation
      - url: https://coddingtonbear.github.io/obsidian-local-rest-api/
        type: API Reference
      - url: https://github.com/coddingtonbear/obsidian-local-rest-api
        type: GitHub
      - url: openapi/obsidian-local-rest-api-openapi.yaml
        type: OpenAPI
    description: >-
      Community-built plugin (by @coddingtonbear) that exposes the Obsidian vault over a local HTTPS REST API on port 27124. Endpoint groups include Vault file CRUD, Active File, Periodic Notes (daily/weekly/monthly), Search, Commands, Tags, and File Opening. Bearer-token authenticated. Used by browser extensions, scripts, and AI agents to read and write into a running Obsidian instance.
  - aid: obsidian:obsidian-sync
    name: Obsidian Sync
    tags:
      - Sync
      - Cross-Device
      - End-to-End Encryption
    image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://obsidian.md/sync
    baseURL: managed
    properties:
      - url: https://obsidian.md/sync
        type: Documentation
    description: >-
      Paid managed service that syncs an Obsidian vault across devices with end-to-end encryption, version history, and shared-vault collaboration. Not exposed as a public REST API; integration is via the Obsidian client.
  - aid: obsidian:obsidian-publish
    name: Obsidian Publish
    tags:
      - Publishing
      - Web
      - Hosting
    image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://obsidian.md/publish
    baseURL: managed
    properties:
      - url: https://obsidian.md/publish
        type: Documentation
    description: >-
      Paid managed service that publishes selected notes from an Obsidian vault as a public website with graph view, full-text search, and customizable themes. Not exposed as a public REST API; configured from within Obsidian.
common:
  - type: Website
    url: https://obsidian.md/
  - type: Documentation
    url: https://docs.obsidian.md/Home
  - type: Pricing
    url: https://obsidian.md/pricing
  - type: GitHub
    url: https://github.com/obsidianmd
  - type: Plans
    url: plans/obsidian-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/obsidian-rate-limits.yml
  - type: FinOps
    url: finops/obsidian-finops.yml
maintainers:
  - FN: Kin Lane
    email: [email protected]