skills.rest
twjarviszyra-web
twjarviszyra-webCOMMUNITY
Explore all skills by this author →
GitHub

siyuan

Automates SiYuan note and block management via the kernel API.

3|Updated Apr 4, 2026
Search Tags:#api#knowledge base#notes#blocks#curl#siyuan
One-click install
npx skills add https://github.com/twjarviszyra-web/hermes-unbound --skill siyuan-twjarviszyra-web
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/twjarviszyra-web/hermes-unbound/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/twjarviszyra-web/hermes-unbound --skill siyuan-twjarviszyra-web

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the friction of manually searching, editing, and organizing content inside a SiYuan knowledge base by letting you drive the app through its API.

Core Features & Use Cases

  • Search notes with full-text or SQL queries.
  • Read blocks, child blocks, paths, attributes, and exports for inspection or reporting.
  • Create and update documents, append content, rename notes, and manage notebooks from a single workflow.
  • Example: ask for a topic search across your notebook, then extract the matching blocks into a concise summary.

Quick Start

Ask the assistant to connect to your SiYuan instance, search for a topic, and summarize the matching blocks.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I search a SiYuan knowledge base using the API?▼

Search a SiYuan knowledge base by sending POST-based JSON requests to the kernel API, using full-text search or SQL retrieval to find matching blocks. This requires token authentication for access.

Can I automate document creation and block editing in SiYuan notes?▼

Automate document creation, block editing, and notebook organization in SiYuan notes through the kernel API. Append content, rename notes, and update documents programmatically with strict block and document ID validation.

Does the SiYuan API allow SQL queries for retrieving notes?▼

The SiYuan API supports SQL retrieval for querying notes, enforcing safe SELECT-only querying to ensure reliable automation when extracting blocks and attributes from your self-hosted knowledge base.

What do I need to connect to a self-hosted SiYuan knowledge base via API?▼

Connecting to a self-hosted SiYuan knowledge base requires sending POST-based JSON requests to the kernel API with token authentication. This enables management of notebooks, blocks, and documents.

Are there limitations when reading blocks and exports from SiYuan?▼

Reading blocks, child blocks, paths, attributes, and exports from SiYuan requires strict block and document ID validation to ensure reliable automation and prevent retrieval errors across your notebooks.

Related Skills

Explore More Education & Research Skills→
icyzhicyzh
1

siyuan

Interact with the SiYuan kernel API to search and modify knowledge base blocks.

Community
Intermediate
Z43LZ43L

siyuan

Search, read, and manage SiYuan blocks and documents via POST JSON API requests.

Community
Intermediate
vikrant-projectvikrant-project
2

siyuan

Manage SiYuan Note documents via the SiYuan Note API.

Community
Intermediate
ZouZouZouZou

Advanced Search & Filtering Skill

Implement full-text search and multi-criteria filtering across courses and content.

Community
Advanced