siyuan

Access the SiYuan kernel API to search, read, create, update, and delete blocks and documents.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manage and automate interactions with a self-hosted SiYuan knowledge base via API, reducing manual note maintenance.

Core Features & Use Cases

  • Full API access to SiYuan kernel: search, read, create, update, and delete blocks and documents.
  • Automate knowledge-base workflows: batch note creation, structured updates, and cross-notebook organization.
  • Example: programmatically consolidate scattered notes into notebooks and keep metadata in sync.

Quick Start

Query the SiYuan kernel API to search, read, create, update, and delete blocks and documents.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate note creation in a self-hosted SiYuan knowledge base?

Automating note creation in a self-hosted SiYuan knowledge base involves accessing the kernel API to send HTTP requests via curl to endpoints for creating blocks and documents. It requires a running SiYuan instance and an API token.

What is the best way to batch update content across SiYuan notebooks?

Batch updating content across SiYuan notebooks is best handled by accessing the SiYuan kernel API to programmatically search, update, and manage blocks. This reduces manual note maintenance and keeps metadata synchronized across notebooks.

Do I need an API token to manage SiYuan blocks via curl?

Yes, you need an API token to manage SiYuan blocks via curl. Accessing kernel API endpoints like /api/block/getBlockKramdown for reading or updating blocks requires a running SiYuan instance and this token for authentication.

Can I search and read specific blocks in a SiYuan knowledge base programmatically?

You can search and read specific blocks in a SiYuan knowledge base programmatically by making HTTP requests to the kernel API. Endpoints such as /api/block/getBlockKramdown allow you to retrieve and read block content directly.

Does the SiYuan API support deleting documents and blocks through HTTP requests?

Yes, the SiYuan API supports deleting documents and blocks through HTTP requests. By accessing the kernel API with curl and an API token, you can programmatically manage the full lifecycle of your knowledge base content including deletion operations.