跳轉至

Obsidian Local REST API plugin

概覽

Obsidian Local REST API 是一個第三方社區插件，它為 obsidian 提供了一個基於 HTTP 的本地伺服器接口。通過這個插件，外部應用程序、瀏覽器擴展程序或自動化工具（如 n8n）可以與本地的 obsidian 庫（Vault）進行交互，實現讀取、寫入、修改筆記等自動化操作。

需要注意的是，obsidian 本身是一個離線的 Markdown 筆記工具，並不具備原生的雲端 API。因此，任何要求「Obsidian API Key」的第三方工具，其實際上指的都是該插件所提供的訪問令牌（Access Token）。

如何設置與獲取 API Key

要使用依賴於 Obsidian 接口的自動化工具，請按照以下步驟操作：

  1. 安裝插件：進入 obsidian 的 Settings -> Community plugins -> Browse，搜尋並安裝「Local REST API」。
  2. 啟用服務：在插件設置頁面中，確保勾選了「Enable API」選項。插件默認運行在 27123 端口。
  3. 獲取令牌：在該設置面板中，你可以直接看到「API Key」字段。點擊複製該字符串。
  4. 配置外部工具：將此 Key 填入你需要連接的擴展程序（例如 obsidian-ai-exporter）或自動化腳本中，以便完成身份驗證。

工作原理

該插件在本地開啟了一個 HTTP 伺服器，當外部請求（例如來自瀏覽器的 AI 擴展）攜帶正確的 API Key 發送請求時，插件會將請求轉化為 obsidian 的內部指令。這實現了「AI 生成內容 → 自動保存至筆記」的無縫工作流。

常見應用場景

  • AI 助手集成：將網頁上的 AI 對話內容（如 ChatGPT 的分析）直接導出至筆記中。
  • 自動化備份與處理：結合 n8n 等工具，對 Vault 進行編程式的增刪改查。
  • 遠程寫入：在不直接操作 obsidian 界面時，透過 Web 請求遠程新增知識點。

相關注意事項

  • 安全性：由於此插件開啟了本地網絡接口，請確保僅在可信的環境下使用，並妥善保管 API Key。
  • 非官方同步：此 API 主要用於操作筆記內容，而非用作多設備間的資料同步方案。若需要同步，建議配合 syncthing 或 Nextcloud 使用。
  • 插件依賴：如果插件未正確安裝或未開啟，外部工具將無法連接到你的筆記庫。

Sources

See Also