siyuan

Manage SiYuan blocks and documents via curl-based kernel API calls.

Updated Mar 25, 2026
One-click install
npx skills add https://github.com/afel6/scal-ai-pipeline --skill siyuan-afel6
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/afel6/scal-ai-pipeline/tree/main/hermes_skills_library/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/afel6/scal-ai-pipeline --skill siyuan-afel6

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API enables programmatic management of a self-hosted knowledge base. It eliminates the friction of manual note operations by exposing a curl-based interface to search, read, create, update, and delete blocks and documents in SiYuan.

Core Features & Use Cases

  • Search, read, create, update, and delete blocks and documents via the SiYuan kernel API using curl.
  • Manage personal PKM or team knowledge bases with script-driven automation and reproducible workflows.
  • Integrate with automation pipelines to query notes, build indexes, or generate summaries for reports.

Quick Start

Authenticate with your SiYuan instance and perform a sample search for a keyword 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 automate SiYuan note operations via API?

Automate SiYuan note operations via API by using curl commands to search, read, create, update, and delete blocks and documents. This provides fast programmatic access to your personal knowledge base for script-driven automation.

What's the best way to search a SiYuan knowledge base using curl?

Search a SiYuan knowledge base using curl by sending API requests to the SiYuan kernel. Authenticate with your instance, then execute search queries to retrieve structured results for downstream automation and indexing.

Can I use curl to create and update blocks in a SiYuan PKM setup?

You can use curl to create and update blocks in a SiYuan PKM setup. The API exposes endpoints for block and document management, enabling script-driven workflows for personal or team knowledge repositories.

Do I need an authentication token to read SiYuan notes through the kernel API?

You need an authentication token to read SiYuan notes through the kernel API. Handling authentication tokens is required for invoking curl-based API calls and returning structured results from your self-hosted knowledge base.

How does programmatic access to SiYuan blocks work for automation pipelines?

Programmatic access to SiYuan blocks works for automation pipelines by invoking curl-based API calls to query notes, build indexes, or generate summaries. It handles authentication and returns structured results for downstream report generation.

When should I use the SiYuan API instead of manual note operations?

Use the SiYuan API instead of manual note operations when you need reproducible workflows, script-driven automation, or integration with pipelines to manage team knowledge bases and personal PKM setups programmatically.