跳轉至

Obsidian Local REST API

概述

Obsidian Local REST API 是一款由社區開發的 obsidian 插件，旨在為純本地運行的 Markdown 筆記軟體提供一個 HTTP 伺服器介面。透過此插件，外部應用程式與網頁擴充功能（如 obsidian-ai-exporter）能夠與本地的 Vault 進行互動，實現讀取、寫入與管理筆記的功能。

核心概念

由於 obsidian 本身是一個離線應用程式，並不具備官方的雲端 API 或帳戶 API Key，因此無法透過傳統的 API 驗證方式進行整合。Obsidian Local REST API 插件填補了這一空白，它在用戶的本機環境中建立一個輕量級的 HTTP 伺服器（通常運行於預設埠號 27123），並透過 API Key 進行身份驗證，確保安全性。

設定與使用

若要啟用並獲取該插件的 API Key，請執行以下步驟：

  1. 安裝插件：在 Obsidian 中前往 Settings -> Community plugins -> Browse，搜尋並安裝「Local REST API」。
  2. 啟用服務：安裝完成後，進入 Settings -> Local REST API 頁面。
  3. 開啟與配置：確認已勾選 Enable API 選項。在此頁面中，你可以設定連接埠（Port）並查看系統產生的 API Key。
  4. 整合應用：將此 API Key 填入需要與 Obsidian 對接的工具（例如 Chrome 的 AI 匯出擴充功能），即可建立連接。

安全注意事項

  • 本地存取權限：該 API Key 授予外部程式對你本地 Vault 檔案的完全存取權，請確保只在信任的瀏覽器擴充功能或自建的 n8n 自動化流程中使用。
  • 非雲端服務：此 API 僅在你的本機電腦運行 Obsidian 時生效，並非 Obsidian Sync 的替代方案，也不支援遠端遙控關閉的應用程式。

常見應用場景

  • AI 整合：將 chatgpt 或 Claude 的對話記錄，透過 Chrome 擴充功能直接匯出為筆記存入 Vault。
  • 自動化工作流：配合 n8n 節點，將網路資訊或 telegram 訊息自動寫入 Obsidian 的 Daily Note 中。
  • 個人知識庫維護：自動整理與標籤化內容，將零碎資訊轉化為結構化的筆記系統。

對於已經部署 Nextcloud 同步架構的用戶，Obsidian Local REST API 是實現自動化知識管理的關鍵橋樑，能顯著提升從「資料輸入」到「知識轉化」的效率。

Sources

See Also