siyuan

Automate SiYuan Note API operations to search, read, create, update, and delete blocks and documents.

Updated Apr 19, 2026
One-click install
npx skills add https://github.com/gqf2008/hermez-ai --skill siyuan-gqf2008
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/gqf2008/hermez-ai/tree/main/skills/productivity/siyuan
Command: npx skills add https://github.com/gqf2008/hermez-ai --skill siyuan-gqf2008

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API via curl enables developers to search, read, create, update, and delete blocks and documents in a self-hosted knowledge base without heavy tooling.

Core Features & Use Cases

  • Search and retrieve blocks and documents using the SiYuan kernel API.
  • Create, update, rename, and delete content within notebooks and files.
  • Use in PKM workflows to automate knowledge base maintenance, backups, and content curation in CI/CD pipelines.

Quick Start

Query a block by ID using the SiYuan API and return its content.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate SiYuan knowledge base maintenance using curl?

You can automate SiYuan knowledge base maintenance using curl by sending HTTP requests to the SiYuan Note API to search, read, create, update, and delete blocks and documents. This enables automated backups and content curation within CI/CD pipelines.

What do I need to access the SiYuan Note API via curl?

To access the SiYuan Note API via curl, you need to configure your environment with the required SIYUAN_TOKEN and SIYUAN_URL variables. Additionally, the curl and jq command-line tools are used to execute requests and parse JSON responses.

Can I use curl to create and update blocks in a self-hosted SiYuan instance?

Yes, you can use curl to create, update, rename, and delete blocks and documents within notebooks and files in a self-hosted SiYuan instance. This is achieved by interacting directly with the SiYuan kernel API.

How does the SiYuan kernel API handle JSON responses for block queries?

The SiYuan kernel API handles JSON responses by returning standard code and data fields. You can query a block by ID using the API and use jq to parse the returned JSON structure to extract its content.

Is curl-based API access suitable for personal knowledge management workflows?

Curl-based API access is highly suitable for personal knowledge management workflows. It allows developers to automate PKM workflows, perform knowledge-base maintenance, and integrate content curation into CI pipelines without requiring heavy tooling.

What are the limitations of managing SiYuan blocks through the API?

Managing SiYuan blocks through the API requires a self-hosted knowledge base and valid authentication tokens. Users must also be comfortable parsing JSON responses with jq, as the API expects standard code and data fields rather than direct text output.