思源作为一个超级强大的本地优先的笔记软件,自然为用户提供了多种方案让数据快速发送到思源中。
如果你想几句话了解思源的本地API,可以看看知识博主吕立青对思源笔记 API 的评价。
- 云端 API
- 本地 API
这篇文章将着重讲述思源备受好评的本地 API 功能,但在这之前简单介绍下云端 API。
云端 API(收集箱)
云端 API 主要场景就是在不开启思源的情况下,向你的账号发送一些内容。因为它是需要持续支出的云服务,所以是订阅用户的专属特性。
不过不用担心你会错过什么好用的功能,云端 API 的功能并不多,思源社区也基本都是围绕本地 API 在进行开发。
-
有哪些功能使用了云端 API
- 目前已知使用云端 API 的只有思源官方的微信小助手
- 云端 API 开发示例
官方并没有提供自行部署云端 API 的功能,不过话又说回来,如果你有自行部署云端 API 的条件,那不如自行部署思源笔记,然后直接使用它的本地 API
本地 API
本地 API 算是思源笔记中非常重要的特性,对大部分用户来说,只需要知道
本地 API
能做什么,以及它是如何使用的。本地API旨在让用户在使用外部软件时,也可以与思源的知识库进行数据交互(也可以做到跨设备)。
- 比如同一个wifi下,在手机上直接将网页剪藏到电脑上已开启的思源知识库。
注意
- 它其实可以算作是思源的 WebAPI/网络伺服的一部分,但这里为了方便理解,就单独提出来了。
- 浏览器扩展、油猴脚本、第三方应用等我都统称为外部软件。
如果你想试用体验思源的API,或者了解思源的API开发文档,可以在以下网站找到
- 由社区大佬 Wetoria 搭建的ApiFox 交互式体验思源的API
- 社区大佬们共建的 思源社区文档 - 开发者参考
- 思源 Github 仓库 Github - siyuan/API_zh_CN.md
交互式体验思源API需要自己开启思源,大部分API需要填入API token
API 地址的获取
API 地址可以在
设置 > 关于 > 在浏览器中使用
中获取
- 如果你是在同一个设备中打开思源并使用 API,那就是
http://127.0.0.1:端口号
- 如果你是在一个设备中打开思源,然后在同一局域网下的其他设备中使用 API,那就是
http://192.168.xxx.xxx:端口号
- 如果你的思源笔记是部署在云服务器中,或是外出使用,则是
公网地址:端口号
API token 的获取
思源的本地 API token 可以在
设置 > 关于
中获取,你也可以在右侧输入框中设置自定义token
。
API token 的使用
使用方法非常简单
- 打开支持思源 API 的外部软件
- 填入
API地址
和API token
- 根据所使用的软件填写一些自定义信息,比如说用哪个笔记本啊、放在哪里啊之类的
-
有哪些社区功能使用了本地 API?
-
浏览器扩展
-
官方剪藏:目前仅支持 chrome 系的浏览器,firefox 和 safari 正在开发中。
-
…
-
-
油猴脚本
- 思源再提醒油猴插件 - 链滴 让浏览器页面也支持虚拟引用和跳转到思源
- 思源笔记油猴脚本 视频时间戳 + 截图 - 链滴 目前上位替代是思源媒体播放器插件
- …
-
第三方软件
-
集市中有 Memos、Karakeep、Dinox、Flomo、五彩等软件同步到思源的插件
-
utools 插件:通过思源笔记内核 API 进行搜索, 支持保存多个思源笔记服务端地址
-
…
-
-
AI&&自动化工作流
-
cherry studio 和 cursor 等软件可以通过 MCP 对接思源的 SQLite
-
n8n-nodes-siyuan - npm:思源社区用户开发的 n8n 社区节点
-
…
-
-