siyuan

Manage blocks and documents in a SiYuan knowledge base via curl.

Updated May 20, 2026
One-click install
npx skills add https://github.com/SriRamkunamsetty/SITA2.0-HermesAgent --skill siyuan-sriramkunamsetty
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/SriRamkunamsetty/SITA2.0-HermesAgent/tree/main/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/SriRamkunamsetty/SITA2.0-HermesAgent --skill siyuan-sriramkunamsetty

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API via curl enables programmatic search, read, create, update, and organization of blocks and documents in a self-hosted knowledge base, removing manual GUI interactions and speeding up knowledge management.

Core Features & Use Cases

  • Full-text search of blocks and notebooks via API
  • Read, create, update, and delete blocks and documents
  • List notebooks and documents, fetch block content
  • Manage attributes and organize knowledge bases programmatically
  • Use cases: automate knowledge curation, bulk document creation, and integration with other tools

Quick Start

Install SiYuan, generate an API token, set SIYUAN_TOKEN and SIYUAN_URL, and run a curl command to read 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 SiYuan knowledge base operations without the GUI?

Automate SiYuan knowledge base operations by sending curl commands to the SiYuan kernel API to search, read, create, update, and delete blocks and documents programmatically. Set the SIYUAN_URL and SIYUAN_TOKEN environment variables to authenticate.

What do I need to access the SiYuan note API remotely?

Accessing the SiYuan note API remotely requires a running SiYuan instance, a generated API token, and curl installed. Set the SIYUAN_URL environment variable to your remote instance address and SIYUAN_TOKEN for authentication.

Can I perform full-text searches across SiYuan notebooks using curl?

Yes, you can perform full-text searches across SiYuan notebooks and blocks by sending search queries through the SiYuan kernel API via curl, returning matching block content and metadata without manual GUI interaction.

How do I bulk update or create documents in a self-hosted SiYuan instance?

Bulk update or create documents in self-hosted SiYuan by scripting curl API requests. Use the SiYuan kernel API to push block-level create and update payloads, automating routine knowledge curation and document organization.

How do I manage block attributes in a SiYuan knowledge base via API?

Manage block attributes in a SiYuan knowledge base by sending curl requests to the SiYuan kernel API. You can programmatically read, set, and organize block attributes to automate knowledge base curation.

Does this approach work for self-hosted SiYuan setups only?

This curl API approach targets self-hosted SiYuan setups. By configuring the optional SIYUAN_URL environment variable, you direct curl requests to either a local or remote running SiYuan instance.