siyuan

Perform CRUD operations on blocks and documents via the SiYuan Note API.

Updated Jul 3, 2026
One-click install
npx skills add https://github.com/LynxLabVN/office-agent --skill siyuan-lynxlabvn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/LynxLabVN/office-agent/tree/main/agent-core/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/LynxLabVN/office-agent --skill siyuan-lynxlabvn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Manages blocks and documents in a self-hosted SiYuan knowledge base, solving the problem of organizing and accessing information across various notes and documents.

Core Features & Use Cases

  • API Access: Connects with SiYuan Note API to perform actions like searching, reading, creating, and managing blocks and documents.
  • Efficient Knowledge Base Management: Streamlines the process of organizing notes and information in a self-hosted knowledge base.
  • Use Case: Ideal for users who need to manage large volumes of notes and documents and want to leverage the power of SiYuan Note's API for efficient data management.

Quick Start

Use the siyuan skill to search for notes containing the keyword 'project' in your SiYuan knowledge base.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan knowledge base blocks programmatically?

To manage SiYuan knowledge base blocks programmatically, you can use an API integration to perform CRUD operations on blocks and documents within a self-hosted instance. This allows direct interaction with your notes for automated management.

Can I use curl and jq for SiYuan Note API integration?

Yes, you can use curl and jq for SiYuan Note API integration to handle command-line interactions. This combination parses JSON responses and executes requests to search, read, and create blocks efficiently.

What is the best way to automate document creation in a self-hosted knowledge base?

Automating document creation in a self-hosted knowledge base is best achieved through direct API access. By sending programmatic requests, you can seamlessly create and organize large volumes of notes and documents.

Does this API integration support searching for specific notes by keyword?

Yes, this API integration supports searching for specific notes by keyword within your SiYuan knowledge base. You can query terms like 'project' to quickly retrieve and read matching documents via the API.

How do I search for notes containing specific keywords in my SiYuan knowledge base?

To search for notes containing specific keywords in your SiYuan knowledge base, you execute API calls via the command line. This queries your self-hosted instance and returns the matching blocks or documents directly.