Siyuan

SiYuan Note API，用于通过 curl 在自托管知识库中搜索、读取、创建和管理块和文档。

技能元数据


来源	可选 — 使用 `hermes skills install official/productivity/siyuan` 安装
路径	`optional-skills/productivity/siyuan`
版本	`1.0.0`
作者	FEUAZUR
许可证	MIT
标签	`SiYuan`, `Notes`, `Knowledge Base`, `PKM`, `API`
相关技能	`obsidian`, `notion`

参考：完整 SKILL.md

信息

以下是 Hermes 在触发此技能时加载的完整技能定义。这是技能激活时代理看到的指令。

SiYuan Note API

通过 curl 使用 SiYuan 内核 API，在自托管知识库中搜索、读取、创建、更新和删除块和文档。无需额外工具——只需 curl 和 API 令牌。

前提条件

安装并运行 SiYuan（桌面版或 Docker）
获取你的 API 令牌：设置 > 关于 > API 令牌
将其存储在 ~/.hermes/.env 中：
```
SIYUAN_TOKEN=your_token_here
SIYUAN_URL=http://127.0.0.1:6806
```
如果未设置，SIYUAN_URL 默认为 http://127.0.0.1:6806。

API 基础

所有 SiYuan API 调用均为 带有 JSON 正文的 POST 请求。每个请求都遵循以下模式：

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/..." \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"param": "value"}'

响应为具有以下结构的 JSON：

{"code": 0, "msg": "", "data": { ... }}

code: 0 表示成功。任何其他值均表示错误——请检查 msg 以获取详细信息。

ID 格式： SiYuan ID 类似于 20210808180117-6v0mkxr（14 位时间戳 + 7 个字母数字字符）。

快速参考

操作	端点
全文搜索	`/api/search/fullTextSearchBlock`
SQL 查询	`/api/query/sql`
读取块	`/api/block/getBlockKramdown`
读取子块	`/api/block/getChildBlocks`
获取路径	`/api/filetree/getHPathByID`
获取属性	`/api/attr/getBlockAttrs`
列出笔记本	`/api/notebook/lsNotebooks`
列出文档	`/api/filetree/listDocsByPath`
创建笔记本	`/api/notebook/createNotebook`
创建文档	`/api/filetree/createDocWithMd`
追加块	`/api/block/appendBlock`
更新块	`/api/block/updateBlock`
重命名文档	`/api/filetree/renameDocByID`
设置属性	`/api/attr/setBlockAttrs`
删除块	`/api/block/deleteBlock`
删除文档	`/api/filetree/removeDocByID`
导出为 Markdown	`/api/export/exportMdContent`

常见操作

搜索（全文）

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/search/fullTextSearchBlock" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "meeting notes", "page": 0}' | jq '.data.blocks[:5]'

搜索（SQL）

直接查询块数据库。仅 SELECT 语句是安全的。

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/query/sql" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"stmt": "SELECT id, content, type, box FROM blocks WHERE content LIKE '\''%keyword%'\'' AND type='\''p'\'' LIMIT 20"}' | jq '.data'

常用列：id, parent_id, root_id, box（笔记本 ID）, path, content, type, subtype, created, updated。

读取块内容

以 Kramdown（类似 Markdown）格式返回块内容。

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/block/getBlockKramdown" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "20210808180117-6v0mkxr"}' | jq '.data.kramdown'

读取子块

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/block/getChildBlocks" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "20210808180117-6v0mkxr"}' | jq '.data'

获取人类可读路径

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/filetree/getHPathByID" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "20210808180117-6v0mkxr"}' | jq '.data'

获取块属性

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/attr/getBlockAttrs" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "20210808180117-6v0mkxr"}' | jq '.data'

列出笔记本

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/notebook/lsNotebooks" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}' | jq '.data.notebooks[] | {id, name, closed}'

列出笔记本中的文档

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/filetree/listDocsByPath" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"notebook": "NOTEBOOK_ID", "path": "/"}' | jq '.data.files[] | {id, name}'

创建文档

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/filetree/createDocWithMd" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "notebook": "NOTEBOOK_ID",
    "path": "/Meeting Notes/2026-03-22",
    "markdown": "# Meeting Notes\n\n- Discussed project timeline\n- Assigned tasks"
  }' | jq '.data'

创建笔记本

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/notebook/createNotebook" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My New Notebook"}' | jq '.data.notebook.id'

向文档追加块

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/block/appendBlock" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parentID": "DOCUMENT_OR_BLOCK_ID",
    "data": "New paragraph added at the end.",
    "dataType": "markdown"
  }' | jq '.data'

还可使用：/api/block/prependBlock（参数相同，插入到开头）和 /api/block/insertBlock（使用 previousID 而非 parentID 在特定块之后插入）。

更新块内容

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/block/updateBlock" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "BLOCK_ID",
    "data": "Updated content here.",
    "dataType": "markdown"
  }' | jq '.data'

重命名文档

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/filetree/renameDocByID" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "DOCUMENT_ID", "title": "New Title"}'

设置块属性

自定义属性必须以 custom- 为前缀：

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/attr/setBlockAttrs" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "BLOCK_ID",
    "attrs": {
      "custom-status": "reviewed",
      "custom-priority": "high"
    }
  }'

删除块

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/block/deleteBlock" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "BLOCK_ID"}'

要删除整个文档：使用 /api/filetree/removeDocByID 并传入 {"id": "DOC_ID"}。要删除笔记本：使用 /api/notebook/removeNotebook 并传入 {"notebook": "NOTEBOOK_ID"}。

将文档导出为 Markdown

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/export/exportMdContent" \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "DOCUMENT_ID"}' | jq -r '.data.content'

块类型

SQL 查询中常见的 type 值：

类型	描述
`d`	文档（根块）
`p`	段落
`h`	标题
`l`	列表
`i`	列表项
`c`	代码块
`m`	数学块
`t`	表格
`b`	引用块
`s`	超级块
`html`	HTML 块

陷阱

所有端点均为 POST —— 即使是只读操作。请勿使用 GET。
SQL 安全：仅使用 SELECT 查询。INSERT/UPDATE/DELETE/DROP 具有危险性，绝不应发送。
ID 验证：ID 需匹配模式 YYYYMMDDHHmmss-xxxxxxx。拒绝任何其他格式。
错误响应：在处理 data 之前，务必检查响应中的 code != 0。
大型文档：块内容和导出结果可能非常大。在 SQL 中使用 LIMIT，并通过管道传递给 jq 以仅提取所需内容。
笔记本 ID：在使用特定笔记本时，请先通过 lsNotebooks 获取其 ID。

替代方案：MCP 服务器

如果您倾向于原生集成而非使用 curl，请安装 SiYuan MCP 服务器：

# In ~/.hermes/config.yaml under mcp_servers:
mcp_servers:
  siyuan:
    command: npx
    args: ["-y", "@porkll/siyuan-mcp"]
    env:
      SIYUAN_TOKEN: "your_token"
      SIYUAN_URL: "http://127.0.0.1:6806"

技能元数据​

参考：完整 SKILL.md​

SiYuan Note API

前提条件​

API 基础​

快速参考​

常见操作​

搜索（全文）​

搜索（SQL）​

读取块内容​

读取子块​

获取人类可读路径​

获取块属性​

列出笔记本​

列出笔记本中的文档​

创建文档​

创建笔记本​

向文档追加块​

更新块内容​

重命名文档​

设置块属性​

删除块​

将文档导出为 Markdown​

块类型​

陷阱​

替代方案：MCP 服务器​