Skip to content

[Integration]: Add Obsidian Knowledge & Task Integration #3741

@y0sif

Description

@y0sif

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_create
  • obsidian_note_get
  • obsidian_note_update
  • obsidian_note_append
  • obsidian_note_delete
  • obsidian_vault_list
  • obsidian_search
  • obsidian_periodic_note_get
  • obsidian_periodic_note_create
  • obsidian_active_file_get
  • obsidian_command_list
  • obsidian_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:

  1. Open Obsidian desktop application
  2. Go to Settings → Community plugins
  3. Search for and install "Local REST API" plugin
  4. Enable the plugin
  5. Go to Settings → Local REST API
  6. Click "Generate API Key"
  7. Copy the API key
  8. 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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions