siyuan

Manage SiYuan blocks and documents via curl REST API calls.

Updated May 26, 2026
One-click install
npx skills add https://github.com/ruiyangruiyi/hermes-agent --skill siyuan-ruiyangruiyi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/ruiyangruiyi/hermes-agent/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/ruiyangruiyi/hermes-agent --skill siyuan-ruiyangruiyi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the friction of manually searching, reading, and updating notes in a self-hosted SiYuan knowledge base by letting you manage documents and blocks through simple curl calls.

Core Features & Use Cases

  • Full-text and SQL search: Find relevant blocks quickly by keyword using SiYuan’s search endpoints or safe SELECT-only SQL.
  • Read and traverse blocks: Retrieve block Kramdown (Markdown-like) content and navigate child blocks and document structure.
  • Create, append, update, and delete: Create notebooks/documents, append/update block content, set custom attributes, and remove blocks or documents.
  • Export content: Export a document’s content as Markdown for sharing, archiving, or downstream processing.

Quick Start

Use the siyuan skill to search for “meeting notes” in your SiYuan instance by providing your SIYUAN_TOKEN and SIYUAN_URL (optional) and letting it call the full-text search endpoint.

Frequently Asked Questions about siyuan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search my SiYuan notes programmatically?

You can search SiYuan notes by sending POST JSON requests with an Authorization Token header to SiYuan's REST search endpoints, enabling full-text keyword discovery and SQL-based querying.

Can I automate block creation and updates in a SiYuan knowledge base?

Yes, you can automate block management in a SiYuan knowledge base by using curl calls to create, append, update, and delete blocks or documents via SiYuan REST endpoints.

What do I need to access SiYuan blocks via API?

To access SiYuan blocks via API, you need a SIYUAN_TOKEN for the Authorization header and optionally a SIYUAN_URL, sending POST JSON requests to interact with your self-hosted instance.

Does the SiYuan API support exporting documents to Markdown?

Yes, the SiYuan API supports exporting document content as Markdown, allowing you to archive, share, or process Kramdown block content for downstream use via curl.

How do I traverse child blocks using the SiYuan API?

You can traverse child blocks by retrieving block Kramdown content and navigating the document structure through SiYuan REST endpoints using POST JSON requests with an Authorization Token.

What are the limitations of querying SiYuan notes with SQL?

When querying SiYuan notes with SQL, you are limited to safe SELECT-only statements to retrieve block data, ensuring structured block traversal without modifying the underlying knowledge base.