siyuan

Automate SiYuan kernel API operations for blocks and documents.

2|Updated Apr 25, 2026
One-click install
npx skills add https://github.com/AlexiosBluffMara/mercury --skill siyuan-alexiosbluffmara
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/AlexiosBluffMara/mercury/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/AlexiosBluffMara/mercury --skill siyuan-alexiosbluffmara

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API provides programmatic access to search, read, create, update, and delete blocks and documents in a self-hosted SiYuan instance, enabling automation and integration with other tools.

Core Features & Use Cases

  • API-based CRUD for blocks and documents, including read, create, update, and delete operations.
  • Full-text search, path navigation, and attribute retrieval to organize notes efficiently.
  • Use Case: Integrate SiYuan with external automations to sync notes to other apps or build dashboards.

Quick Start

Run a curl command against the SiYuan API using your token and SIYUAN_URL to list or modify documents.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate document management in a self-hosted SiYuan knowledge base?

You can automate document management in a SiYuan knowledge base by using the kernel API to perform CRUD operations on blocks and documents. This Skill executes curl commands to search, read, create, update, and delete notes programmatically.

What environment variables do I need to connect to the SiYuan API?

Connecting to the SiYuan API requires the environment variables SIYUAN_TOKEN and SIYUAN_URL to be set. These credentials allow the Skill to authenticate and route curl requests to your self-hosted instance.

Does the SiYuan note API support full-text search and attribute retrieval?

Yes, the SiYuan note API supports full-text search, path navigation, and attribute retrieval to organize notes efficiently. You can query blocks and documents directly to locate specific information within your knowledge base.

Can I use curl and jq to interact with SiYuan blocks without a graphical interface?

Yes, you can use curl and jq to interact with SiYuan blocks without a GUI because this Skill depends on both tools to communicate with the API. They handle sending HTTP requests and parsing the JSON responses returned by the kernel.

How do I integrate my local notes with external automations using SiYuan?

You integrate local notes with external automations using SiYuan by calling the API to sync notes to other apps or build dashboards. The Skill automates block and document operations so external tools can trigger updates programmatically.

Why is my SiYuan API request failing when I try to list documents?

Your SiYuan API request may fail if the required environment variables SIYUAN_TOKEN and SIYUAN_URL are missing or incorrect. The Skill enforces these variables and relies on curl and jq to communicate with the API successfully.