siyuan

Search, read, create, and manage blocks and documents via the SiYuan Note API.

4|Updated Apr 19, 2026
One-click install
npx skills add https://github.com/ragnarokhaa/hermes --skill siyuan-ragnarokhaa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/ragnarokhaa/hermes/tree/main/hermes-cerul-tech-news-package/hermes-cerul-tech-news-package/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/ragnarokhaa/hermes --skill siyuan-ragnarokhaa

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill simplifies interacting with the SiYuan Note API, allowing users to search, read, create, and manage blocks and documents in their self-hosted knowledge base.

Core Features & Use Cases

  • API Access: Access the SiYuan Note API for operations such as searching, reading, creating, and managing blocks and documents.
  • Command Line Operations: Utilize curl and jq to perform tasks without extra tools.
  • Use Case: For users who need to automate workflows within SiYuan Note, such as creating new documents or updating existing ones, this Skill provides a powerful toolset.

Quick Start

Use the siyuan skill to search for notes related to 'project management' 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 Note blocks and documents via API?

You can manage SiYuan Note blocks and documents by using this Skill to interact with the SiYuan Note API. It utilizes curl for executing API calls to search, read, create, and manage your self-hosted knowledge base content.

Do I need curl and jq to automate SiYuan Note document workflows?

Yes, you need curl and jq to automate SiYuan Note document workflows. Curl handles the API requests, while jq processes the JSON responses, enabling command line operations without requiring any extra tools.

What is required to access the SiYuan Note API for block management?

Accessing the SiYuan Note API for block management requires an API token and the URL of your SiYuan instance. These credentials authorize the curl commands to search and modify your self-hosted knowledge base.

Can I search and read SiYuan documents from the command line?

Yes, you can search and read SiYuan documents directly from the command line. The Skill sends search queries through the SiYuan Note API and formats the returned JSON data using jq for easy reading.

Does this approach for SiYuan API interaction work with a self-hosted knowledge base?

Yes, this approach works specifically with a self-hosted SiYuan knowledge base. By pointing the curl commands to your instance URL with a valid API token, you can seamlessly create and manage blocks.

Why does my SiYuan API request fail when creating new documents?

SiYuan API requests for creating new documents may fail if the curl command lacks a valid API token or the correct SiYuan instance URL. Ensure your authentication credentials are properly configured before executing operations.