siyuan

Manage SiYuan blocks, notes, and notebooks via curl API calls.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API provides programmatic access to manage a self-hosted knowledge base via curl, enabling teams to automate data entry, retrieval, and maintenance without manual UI interaction.

Core Features & Use Cases

  • Search, read, create, update, and delete blocks and documents through the SiYuan kernel API.
  • Manage notebooks, file trees, attributes, and content in a local or remote SiYuan instance.
  • Use cases include automating note-taking pipelines, syncing notes between devices, and bulk content operations.

Quick Start

Install SiYuan, set SIYUAN_TOKEN and SIYUAN_URL, and run a curl command to fetch a block.

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 and manage blocks in a SiYuan knowledge base?

You can automate note creation and manage blocks in a SiYuan knowledge base by sending curl requests to the SiYuan kernel API. This allows you to perform search, read, create, update, and delete operations on blocks, notes, and notebooks programmatically.

What environment variables do I need to connect to a SiYuan instance via curl?

To connect to a SiYuan instance via curl, you need to set the SIYUAN_TOKEN and SIYUAN_URL environment variables. These variables authenticate your session and define the target endpoint for your local or remote instance.

Can I use curl to search and retrieve document content from a remote SiYuan instance?

Yes, you can use curl to search and retrieve document content from a remote SiYuan instance. By calling standard endpoints like /api/block/getBlockKramdown, you can read and manage file trees, attributes, and content across your self-hosted knowledge base.

What is the best way to bulk update notes and attributes in a self-hosted knowledge base?

The best way to bulk update notes and attributes in a self-hosted knowledge base is through programmatic API access. Using curl to send requests to the SiYuan API enables automated data entry, retrieval, and maintenance without manual UI interaction.

Does the SiYuan API support deleting notebooks and managing file trees programmatically?

Yes, the SiYuan API supports deleting notebooks and managing file trees programmatically. It provides standard endpoints like /api/notebook/lsNotebooks to handle create, update, and delete operations across notebooks and documents via curl.