siyuan

Interact with the Siyuan Notes API using curl commands.

3|1|Updated May 19, 2026
One-click install
npx skills add https://github.com/Quill-Agent/Quill-Agent --skill siyuan-quill-agent
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/Quill-Agent/Quill-Agent/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/Quill-Agent/Quill-Agent --skill siyuan-quill-agent

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Siyuan Notes is a versatile knowledge base tool, and this Skill simplifies the process of interacting with its API for advanced users who want to automate tasks or manage their notes programmatically.

Core Features & Use Cases

  • API Integration: Leverage the Siyuan Notes API to search, read, create, and manage blocks and documents programmatically.
  • Automation: Automate repetitive tasks such as searching, updating, and managing content within Siyuan Notes.
  • Use Case: If you need to create a document with structured notes every day, this Skill allows you to automate the process using curl commands and a Siyuan API token.

Quick Start

To get started, ensure you have Siyuan installed and configured. Obtain your API token and instance URL, then run a command like this: `curl -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/search/fullTextSearchBlock" -H "Authorization: Token $SIYUAN_TOKEN" -H "Content-Type: application/json" -d '{"query": "your search query"}'

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate document management in SiYuan Notes using the API?

You can automate document management in SiYuan Notes by sending curl POST requests to the SiYuan API endpoints. This allows you to programmatically search, read, create, and manage blocks within your self-hosted knowledge base.

What do I need to interact with the SiYuan Notes API via command line?

To interact with the SiYuan Notes API, you need curl and jq installed on your system. You also need a running SiYuan instance, your specific API token, and the instance URL to authenticate your requests.

Can I use curl to search for blocks in my SiYuan knowledge base?

Yes, you can use curl to search for blocks by sending a POST request to the fullTextSearchBlock API endpoint. Include your API token in the Authorization header and your search query in the JSON payload.

What is the best way to automatically create structured notes in SiYuan every day?

The best way to automatically create structured notes daily is to automate the process using curl commands and your SiYuan API token. This script-based approach programmatically builds and manages your documents without manual input.

Does this API integration approach require any external libraries besides curl?

Yes, this API integration approach requires jq alongside curl. While curl handles the HTTP requests to the SiYuan API, jq is necessary to parse and process the JSON data returned from your document automation commands.

Why do I need an API token to automate tasks with SiYuan Notes?

You need an API token to authenticate your automated curl commands with the self-hosted SiYuan instance. Including the token in the Authorization header ensures your programmatic requests for block management are securely processed.