siyuan

Search and manage SiYuan knowledge base notes via API operations.

Updated Jun 25, 2026
One-click install
npx skills add https://github.com/davpatel605-beep/hermusagent --skill siyuan-davpatel605-beep
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/davpatel605-beep/hermusagent/tree/main/backend/vendor/hermes/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/davpatel605-beep/hermusagent --skill siyuan-davpatel605-beep

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users automate interaction with self-hosted SiYuan knowledge bases without manually navigating the application, enabling efficient note retrieval and management.

Core Features & Use Cases

  • Knowledge Base Search: Search SiYuan documents and blocks using full-text or SQL queries.
  • Document Management: Read, create, update, rename, export, and delete notes and blocks through the SiYuan API.
  • Use Case: A researcher can use this Skill to find relevant notes, extract document content, and organize knowledge stored in a personal SiYuan workspace.

Quick Start

Use the siyuan skill to search my SiYuan knowledge base for notes about project planning and summarize the relevant documents.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate searching and reading notes in a self-hosted SiYuan knowledge base?

To automate document management in a self-hosted SiYuan instance, you can use API workflows to read, create, update, rename, export, and delete notes. This allows efficient document retrieval and organization without manually navigating the application interface.

Can I use curl and jq to interact with my SiYuan personal knowledge management workspace?

Yes, you can use curl and jq to interact with a SiYuan personal knowledge management workspace. The system executes validated JSON-based requests using these command-line tools alongside SiYuan API authentication variables to automate knowledge base access.

What is the best way to retrieve document content from SiYuan for automated research workflows?

The best way to retrieve document content from SiYuan for automated research workflows is by applying API operations to search documents and extract content. This enables researchers to find relevant notes and organize knowledge stored in personal workspaces efficiently.

Do I need API authentication variables to manage SiYuan blocks through API requests?

Yes, you need SiYuan API authentication variables to manage SiYuan blocks through API requests. These variables, along with curl and jq, are required dependencies to execute validated JSON-based requests for searching, reading, and organizing document blocks.

Does this approach support exporting and renaming notes in bulk within a SiYuan instance?

Yes, this API approach supports exporting and renaming notes within a SiYuan instance. By automating access to the knowledge base, users can perform document management tasks like reading, creating, updating, renaming, exporting, and deleting notes and blocks.

When do I need to use SQL queries for document retrieval in a personal knowledge management system?

You need to use SQL queries for document retrieval in a personal knowledge management system when performing advanced searches across SiYuan documents and blocks. This allows precise extraction of document content for research and organization workflows via the API.