Skip to content

API Integration Blueprint

Dedicated Integration Recipes

The API integration guide has been expanded into production-ready blueprints in the new API Architecture Section.

Please visit Integration Recipes & Blueprints for full code recipes and error-handling patterns.

Integration Strategies Summary

  1. Third-Party Obsidian Plugins: Request access via PublicAPI.requestAccess() and call methods on AuthorizedAPI. See Plugin Blueprint.
  2. In-Obsidian User Scripts (DataviewJS / Templater): Pass Personal Access Token (PAT) to PublicAPI.withToken(). See DataviewJS / Templater Blueprints.
  3. CLI / External Automation (Bash, Python, Cron): Enable the Local REST Server and authenticate requests via HTTP Bearer tokens. See Python & cURL Blueprints.

API Integration Recipes · API Architecture Index · System Architecture Index