Obsidian website screenshot

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.

Obsidian publishes 9 APIs on the APIs.io network, including Active File API, Commands API, Open API, and 6 more. Tagged areas include Productivity, Knowledge Management, Markdown, Notes, and Local-First.

Obsidian’s developer surface includes authentication, documentation, pricing, GitHub presence, engineering blog, and 11 more developer resources.

39.6/100 thin ▬ flat Agent 44/100 agent ready Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemiumSelf serve⚡ Free to try
10 APIs
ProductivityKnowledge ManagementMarkdownNotesLocal-First

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 39.6/100 · thin
Contract Quality 13.1 / 25
Developer Ergonomics 4.3 / 20
Commercial Clarity 10.0 / 20
Operational Transparency 4.8 / 13
Governance 0.0 / 12
Discoverability 7.4 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/obsidian: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 10

Individual APIs this provider publishes, each with its own machine-readable definition.

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 Active File API

The Active File API from Obsidian — 1 operation(s) for active file.

Obsidian Commands API

The Commands API from Obsidian — 2 operation(s) for commands.

Obsidian Open API

The Open API from Obsidian — 1 operation(s) for open.

Obsidian Periodic Notes API

The Periodic Notes API from Obsidian — 2 operation(s) for periodic notes.

Obsidian Search API

The Search API from Obsidian — 2 operation(s) for search.

Obsidian System API

The System API from Obsidian — 3 operation(s) for system.

Obsidian Tags API

The Tags API from Obsidian — 1 operation(s) for tags.

Obsidian Vault Directories API

The Vault Directories API from Obsidian — 2 operation(s) for vault directories.

Obsidian Vault Files API

The Vault Files API from Obsidian — 1 operation(s) for vault files.

Scroll for all 10

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Obsidian Rate Limits

4 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Obsidian Authentication

http · 1 scheme

SECURITY

Obsidian Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Obsidian Vulnerability Disclosure

disclosure policy published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Obsidian Agentic Access

31 operations · 20 acting

31 operations · 20 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 3

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Commercial 3

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Other 2

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: obsidian
url: https://raw.githubusercontent.com/api-evangelist/obsidian/refs/heads/main/apis.yml
name: Obsidian
kind: 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.
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/obsidian.png
tags:
- Productivity
- Knowledge Management
- Markdown
- Notes
- Local-First
created: '2026-05-08'
modified: '2026-07-25'
specificationVersion: '0.19'
apis:
- aid: obsidian:obsidian-plugin-api
  name: Obsidian Plugin API
  tags:
  - Plugins
  - Extensions
  - SDK
  image: https://kinlane-images.s3.amazonaws.com/shared/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: SDKs
  - 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-active-file-api
  name: Obsidian Active File API
  description: The Active File API from Obsidian — 1 operation(s) for active file.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Active File
  properties:
  - type: OpenAPI
    url: openapi/obsidian-active-file-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-commands-api
  name: Obsidian Commands API
  description: The Commands API from Obsidian — 2 operation(s) for commands.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Commands
  properties:
  - type: OpenAPI
    url: openapi/obsidian-commands-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-open-api
  name: Obsidian Open API
  description: The Open API from Obsidian — 1 operation(s) for open.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Open
  properties:
  - type: OpenAPI
    url: openapi/obsidian-open-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-periodic-notes-api
  name: Obsidian Periodic Notes API
  description: The Periodic Notes API from Obsidian — 2 operation(s) for periodic notes.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Periodic Notes
  properties:
  - type: OpenAPI
    url: openapi/obsidian-periodic-notes-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-search-api
  name: Obsidian Search API
  description: The Search API from Obsidian — 2 operation(s) for search.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/obsidian-search-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-system-api
  name: Obsidian System API
  description: The System API from Obsidian — 3 operation(s) for system.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - System
  properties:
  - type: OpenAPI
    url: openapi/obsidian-system-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-tags-api
  name: Obsidian Tags API
  description: The Tags API from Obsidian — 1 operation(s) for tags.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Tags
  properties:
  - type: OpenAPI
    url: openapi/obsidian-tags-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-vault-directories-api
  name: Obsidian Vault Directories API
  description: The Vault Directories API from Obsidian — 2 operation(s) for vault directories.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Vault Directories
  properties:
  - type: OpenAPI
    url: openapi/obsidian-vault-directories-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
- aid: obsidian:obsidian-vault-files-api
  name: Obsidian Vault Files API
  description: The Vault Files API from Obsidian — 1 operation(s) for vault files.
  humanURL: https://docs.obsidian.md/Home
  baseURL: local
  tags:
  - Vault Files
  properties:
  - type: OpenAPI
    url: openapi/obsidian-vault-files-api-openapi.yml
  - type: Documentation
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
  - type: APIReference
    url: https://coddingtonbear.github.io/obsidian-local-rest-api/
  - type: GitHub
    url: https://github.com/coddingtonbear/obsidian-local-rest-api
common:
- type: AgenticAccess
  url: agentic-access/obsidian-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/obsidian-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/obsidian-domain-security.yml
- type: Authentication
  url: authentication/obsidian-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/obsidianmd
- 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
- type: LlmsText
  url: https://docs.obsidian.md/llms.txt
- type: Blog
  url: https://obsidian.md/feed.xml
- type: ProductPage
  url: https://obsidian.md/sync
- type: ProductPage
  url: https://obsidian.md/publish
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com