siyuan

Name: siyuan
Availability: InStock
Author: mark

Manage SiYuan blocks and documents via curl against a self-hosted instance.

31|3|Updated May 7, 2026

Search Tags:#documents #api #notes #blocks #curl #knowledge-base #siyuan

Ready to run

npx skills add https://github.com/markwang2658/hermes-windows-native --skill siyuan-markwang2658

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/markwang2658/hermes-windows-native/tree/main/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/markwang2658/hermes-windows-native --skill siyuan-markwang2658

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API enables programmatic access to a self-hosted knowledge base, allowing automated search, read, creation, and update of blocks and documents via curl, reducing manual effort and errors.

Core Features & Use Cases

Search and read blocks and documents via the SiYuan kernel API.
Create and update documents and notebooks, and manage content programmatically.
Use cases include building custom note dashboards, bulk content migration, and automation workflows for PKM.

Quick Start

Invoke the SiYuan API workflow by issuing curl commands to manage blocks and documents in your SiYuan instance.

Frequently Asked Questions about siyuan

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

FAQPage Schema

How do I automate searching and reading blocks in a self-hosted SiYuan knowledge base?▼

Automate searching and reading SiYuan blocks by issuing curl commands against the SiYuan kernel API. This requires setting the SIYUAN_TOKEN and SIYUAN_URL environment variables to authenticate and target your self-hosted instance.

Can I create and update SiYuan documents programmatically using curl?▼

Yes, you can create and update SiYuan documents programmatically using curl. The API workflow allows you to manage notebooks and content directly, enabling bulk content migration and automation workflows for personal knowledge management.

What do I need to set up before using the SiYuan API for note management?▼

Before using the SiYuan API, you need curl and jq installed, along with the SIYUAN_TOKEN and SIYUAN_URL environment variables configured. These prerequisites authenticate and route your requests to the self-hosted SiYuan server.

What is the best way to build a custom note dashboard for my local knowledge base?▼

The best way to build a custom note dashboard for a local knowledge base is by programmatically querying the SiYuan kernel API via curl. This lightweight API access allows automated search and read operations to fetch content dynamically.

Does this API approach work for bulk content migration in project documentation?▼

Yes, this API approach works for bulk content migration in project documentation. By automating curl commands to create and update SiYuan blocks and documents, you reduce manual effort and errors when transferring large volumes of notes.

Why should I use curl and jq instead of other tools to manage SiYuan notes?▼

Use curl and jq to manage SiYuan notes when you need lightweight API access without heavy dependencies. This approach directly targets the SiYuan kernel API for programmatic block management, reducing manual effort and errors.