siyuan

Access SiYuan notes via API to perform CRUD operations on blocks and documents.

Updated Apr 16, 2026
One-click install
npx skills add https://github.com/jacardl/New-Radar --skill siyuan-jacardl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/jacardl/New-Radar/tree/main/backend/frameworks/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/jacardl/New-Radar --skill siyuan-jacardl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Access SiYuan notes via API to search, read, create, update, and delete blocks and documents.

Core Features & Use Cases

  • Full CRUD on blocks and documents through curl
  • Search and retrieve content using SiYuan API
  • Manage notebooks and file trees for PKM workflows

Quick Start

Use the SiYuan Note API skill to quickly query or modify your local SiYuan database.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan notes via API using curl?

To manage SiYuan notes via API, you use curl commands to send HTTP requests to your SiYuan instance. This skill defines the necessary endpoints, request formats, and authentication tokens to perform CRUD operations on blocks and documents.

Can I create and update blocks in my SiYuan knowledge base through an API?

Yes, you can create, read, update, and delete blocks and documents in your SiYuan knowledge base through the API. It supports full CRUD operations, allowing you to automate content management workflows.

What do I need to access a self-hosted SiYuan instance remotely via API?

To access a self-hosted SiYuan instance remotely via API, you need the base URL of your deployment and a valid SiYuan API token. The skill uses these credentials to authenticate curl requests for safe operations.

How do I search for content in SiYuan notebooks using the API?

You can search for content in SiYuan notebooks by sending a search request through the API using curl. The skill enables you to query your local or remote SiYuan database to retrieve specific blocks and documents.

Does the SiYuan API work for managing file trees and notebooks?

Yes, the SiYuan API works for managing file trees and notebooks, supporting personal knowledge management workflows. You can automate the organization and structuring of your documents via curl commands.

Why do I need jq when automating SiYuan API workflows with curl?

You need jq to parse the JSON responses returned by SiYuan API requests. When automating workflows with curl, jq extracts and manipulates the retrieved block and document data for further processing or display.