-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Description
Service
Obsidian Local REST API - Enables agents to interact with Obsidian vaults for knowledge management. Agents can create, read, update, search markdown notes, manage periodic notes (daily/weekly/monthly), and execute Obsidian commands.
Description: API key for Obsidian Local REST API plugin — enables vault automation and knowledge management
Credential Identity
- credential_id:
obsidian - env_var:
OBSIDIAN_API_KEY - credential_key:
api_key
Tools
Tool function names that require this credential:
obsidian_note_createobsidian_note_getobsidian_note_updateobsidian_note_appendobsidian_note_deleteobsidian_vault_listobsidian_searchobsidian_periodic_note_getobsidian_periodic_note_createobsidian_active_file_getobsidian_command_listobsidian_command_execute
Auth Methods
- Direct API key supported: Yes
- Aden OAuth supported: No
The API key is generated within the Obsidian plugin and passed as a Bearer token.
How to Get the Credential
Link: Generated within Obsidian app (no external registration)
Step-by-step instructions:
- Open Obsidian desktop application
- Go to Settings → Community plugins
- Search for and install "Local REST API" plugin
- Enable the plugin
- Go to Settings → Local REST API
- Click "Generate API Key"
- Copy the API key
- Note the API URL (default:
https://127.0.0.1:27123)
Note: Obsidian must remain running for API access. The API runs locally on the user's machine.
Health Check
A lightweight API call to validate the credential (no writes, no charges).
- Endpoint:
https://127.0.0.1:27123/vault/ - Method:
GET - Auth header:
Authorization: Bearer {api_key} - Parameters (if any): None
- 200 means: Key is valid, returns list of vault files
- 401 means: Invalid or missing API key
- Connection refused means: Obsidian not running or plugin not enabled
Credential Group
Does this require multiple credentials configured together?
- No, single credential
- Yes — list the other credential IDs in the group:
Note: The API URL (https://127.0.0.1:27123) should be configurable separately as it may vary.
Additional Context
- API Docs: https://github.com/coddingtonbear/obsidian-local-rest-api
- Interactive Docs: https://coddingtonbear.github.io/obsidian-local-rest-api/
- Rate Limits: None (local API)
- Free Tier: 100% free, open-source
- SSL: Uses self-signed certificate, may need SSL verification bypass
- Requirements: Obsidian desktop app must be running, plugin installed and enabled
- Reference: [Integration]: Expand agent capabilities by adding more integrations/tools #2805