siyuan

Manage SiYuan knowledge base blocks, documents, and notebooks via kernel API with curl.

Updated Jun 19, 2026

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

Ready to run

npx skills add https://github.com/AnandaAnugrahHandyanto/savarez_agent --skill siyuan-anandaanugrahhandyanto

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/AnandaAnugrahHandyanto/savarez_agent/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/AnandaAnugrahHandyanto/savarez_agent --skill siyuan-anandaanugrahhandyanto

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API enables programmatic access to search, read, create, update, and delete blocks and documents in a self-hosted SiYuan knowledge base using curl and an API token.

Core Features & Use Cases

Full CRUD on blocks, documents, and notebooks via the SiYuan kernel API.
Full-text search and path navigation to quickly locate notes and sections.
Automations for PKM workflows: create, organize, and update notes from external triggers.

Quick Start

Authenticate with your SiYuan API token and run a curl command to list notebooks from 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 manage SiYuan notes using the API?▼

You can manage SiYuan notes by sending curl POST requests to the kernel API endpoints using an API token. This enables full CRUD operations on blocks, documents, and notebooks in your self-hosted knowledge base.

What do I need to automate my personal knowledge base with curl?▼

To automate your knowledge base, you need a running SiYuan instance, a valid API token, and curl installed. Optional jq is recommended for shaping the JSON responses from the API endpoints.

Can I perform full-text searches in SiYuan remotely?▼

Yes, you can perform full-text searches in a remote SiYuan deployment by executing curl commands against the kernel API. This allows you to quickly locate notes and sections from external triggers.

How does the SiYuan kernel API handle block updates?▼

The SiYuan kernel API handles block updates through POST endpoints that accept specific data formats. You send authenticated curl requests to create, update, or delete blocks and documents within your notebooks.

Does this API approach work for both local and remote SiYuan deployments?▼

Yes, the curl API approach works for both local and remote SiYuan deployments. As long as you have network access to the running kernel instance and a valid API token, you can manage your notes.

What are the limitations of using curl to manage a SiYuan knowledge base?▼

Using curl to manage a SiYuan knowledge base is limited to the endpoints and data formats exposed by the kernel API. Complex operations may require constructing large JSON payloads and manually parsing responses with jq.