上一篇
(3364期)openfunderse-strategy – 智能风控的链上策略管家
下一篇
(3362期)E2e Test Orchestrator – 智能 E2E 测试编排,自动修复零阻塞
思源笔记官方API客户端 思源笔记官方API客户端,支持完整的笔记本/文档/块管理,提供Python SDK与CLI工具集,实现程序化笔记自动化与数据集成。 使用说明 核心用法 SiYuan Note API Client 是思源笔记的官方HTTP API封装,提供两种使用模式: Python SDK模式:通过 SiYuanClient 类实现精细化的笔记编程操作。支持完整的CRUD生命周期——从笔记本的创建/开关/重命名,到文档的Markdown导入导出、层级移动,再到块级操作(插入、追加、更新、折叠、属性标记)。内置SQL查询接口可直接操作底层SQLite数据库,支持模板渲染、资源上传、Pandoc格式转换等高级功能。 CLI工具模式:8个独立脚本覆盖日常高频场景——list/read/search/export/create/delete/move/update,支持JSON输出和管道集成,适合自动化脚本与定时任务。 配置仅需两步:从思源设置获取API Token,填写 config.yaml 中的base_url与token。注意端口可能随重启变化(默认6806)。 显著优点 功能完整性:覆盖思源笔记几乎全部本地API端点,包括系统状态、通知推送、网络代理等边缘能力 工程成熟度:自动重试+指数退避、连接健康检查、操作日志记录、全面的异常处理 双模交互:既满足程序化集成的SDK需求,也提供零代码门槛的CLI工具 数据可移植性:原生支持Markdown导入导出,配合Pandoc实现多格式转换 块级精细化:超越传统文档操作,支持思源特色的块引用、块属性、块转移等高级特性 潜在局限 本地依赖:必须保持思源笔记桌面端运行,无法独立云端部署 端口动态性:SiYuan可能随机分配端口,需人工维护config或实现动态发现 Token管理:长期有效token存储于本地文件,多设备同步存在安全隐患 无官方云API:仅支持本地HTTP接口,无法直接操作云端同步数据 SQLite直读风险:虽然标注"read-only recommended",但SQL接口存在误操作可能 适合人群 需要批量处理笔记数据的自动化用户 希望将思源笔记作为个人知识库后端(PKM backend)的开发者 有Markdown-centric工作流、需要与其他工具链集成的效率用户 熟悉Python、希望自定义笔记插件/工作流的技术用户 常规风险 | 风险类型 | 说明 ||---------|------|| 数据丢失 | 批量删除/移动操作不可逆,CLI的 --yes 跳过确认需慎用 || 连接中断 | 网络波动或思源重启可能导致操作失败,虽可重试但事务不保证原子性 || 端口冲突 | 多实例或防火墙可能阻断6806端口,需检查 ss -tlnp || Token泄露 | 配置文件明文存储token,建议设置适当文件权限(600) || 版本兼容性 | 思源版本升级可能API变更,需关注官方changelog同步更新client | 原始说明 SiYuan Note (思源笔记) API client - Complete notebook, document and block management
思源笔记官方API客户端
思源笔记官方API客户端,支持完整的笔记本/文档/块管理,提供Python SDK与CLI工具集,实现程序化笔记自动化与数据集成。
SiYuan Note API Client 是思源笔记的官方HTTP API封装,提供两种使用模式:
Python SDK模式:通过 SiYuanClient 类实现精细化的笔记编程操作。支持完整的CRUD生命周期——从笔记本的创建/开关/重命名,到文档的Markdown导入导出、层级移动,再到块级操作(插入、追加、更新、折叠、属性标记)。内置SQL查询接口可直接操作底层SQLite数据库,支持模板渲染、资源上传、Pandoc格式转换等高级功能。
CLI工具模式:8个独立脚本覆盖日常高频场景——list/read/search/export/create/delete/move/update,支持JSON输出和管道集成,适合自动化脚本与定时任务。
配置仅需两步:从思源设置获取API Token,填写 config.yaml 中的base_url与token。注意端口可能随重启变化(默认6806)。
| 风险类型 | 说明 |
|———|——|
| 数据丢失 | 批量删除/移动操作不可逆,CLI的 --yes 跳过确认需慎用 |
| 连接中断 | 网络波动或思源重启可能导致操作失败,虽可重试但事务不保证原子性 |
| 端口冲突 | 多实例或防火墙可能阻断6806端口,需检查 ss -tlnp |
| Token泄露 | 配置文件明文存储token,建议设置适当文件权限(600) |
| 版本兼容性 | 思源版本升级可能API变更,需关注官方changelog同步更新client |
SiYuan Note (思源笔记) API client – Complete notebook, document and block management
本站提供的资源转载自国内外各大媒体和网络,仅供试玩体验;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。您必须在下载后的24个小时之内,从您的电脑中彻底删除上述内容。如果您喜欢该游戏内容,请支持正版,购买注册,得到更好的正版服务。我们非常重视版权问题,如有侵权请邮件与我们联系处理。
上一篇
(3364期)openfunderse-strategy – 智能风控的链上策略管家
下一篇
(3362期)E2e Test Orchestrator – 智能 E2E 测试编排,自动修复零阻塞
还没有玩家留言,来抢沙发吧~
登录后即可发表你的资源评测、评分,与其他玩家交流