siyuan

Manage SiYuan blocks and documents via the kernel API with curl.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API enables programmatic interaction with a self-hosted knowledge base to search, read, create, update, and manage blocks and documents via curl.

Core Features & Use Cases

  • Search, read, create, update, and delete blocks and documents using the SiYuan kernel API.
  • Use cases include building knowledge bases, project notes, and team documentation pipelines with automated scripts.
  • Use Case: Integrate a CI workflow to generate daily summaries from notes and push updates to a shared notebook.

Quick Start

Authenticate with SiYuan and perform a sample search for blocks using the API.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan knowledge base blocks using the API?

You can manage SiYuan knowledge base blocks using the API by sending curl requests with JSON bodies to the SiYuan kernel. This allows you to search, read, create, update, and delete blocks and documents programmatically.

Can I use curl to search notes in a local SiYuan instance?

Yes, you can use curl to search notes in a local SiYuan instance by sending requests with JSON bodies to the SiYuan kernel API. You must have a running SiYuan instance and a valid API token to authenticate.

What is needed to automate document creation in SiYuan via API?

To automate document creation in SiYuan via API, you need a running SiYuan instance and a valid API token. You then send curl requests with JSON payloads to create and manage blocks within your knowledge base.

Does the SiYuan API support updating and deleting blocks in a knowledge base?

Yes, the SiYuan API supports updating and deleting blocks in a knowledge base. By targeting the SiYuan kernel API with curl requests, developers can perform full CRUD operations on documents and blocks.

How do I integrate a CI workflow to generate summaries from SiYuan notes?

You can integrate a CI workflow to generate summaries from SiYuan notes by using curl to interact with the SiYuan kernel API. Scripts can retrieve blocks, process content, and push automated updates to a shared notebook.