Note Companion developer resources

Integrate with Note Companion's cloud API (used by the Obsidian plugin and mobile apps) or link agents to our machine-readable docs on notecompanion.ai.

API base URL

Production API: https://app.notecompanion.ai

Authenticate with Authorization: Bearer <api_key> from your Note Companion account (Obsidian plugin settings or web dashboard).

Machine-readable docs

OpenAPI 3.1 specification — operation IDs and schemas for LLM function calling
llms.txt — curated links and agent when-to-use guidance
Sitemap

Health check

GET https://app.notecompanion.ai/api/health — returns { "status": "ok" }

Source code

Nexus-JPF/note-companion on GitHub — Obsidian plugin, web API, and mobile app monorepo.