siyuan

Automate SiYuan block and document operations via HTTP API using curl.

Updated Jun 15, 2026
One-click install
npx skills add https://github.com/faramirezs/talking_printer --skill siyuan-faramirezs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/faramirezs/talking_printer/tree/main/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/faramirezs/talking_printer --skill siyuan-faramirezs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enables programmatic interaction with a self-hosted SiYuan knowledge base by performing search, read, create, update, and delete operations on blocks and documents via the SiYuan HTTP API using curl.

Core Features & Use Cases

  • Full-text search, block read, and document management via SiYuan API using curl.
  • Create or update documents and blocks programmatically, enabling PKM workflows and automation.
  • Use Case: Automate daily note creation, block updates, and exporting content for backups.

Quick Start

Query and manage SiYuan blocks and documents from the command line using curl commands authenticated with SIYUAN_TOKEN and SIYUAN_URL.

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 via API?

You can manage SiYuan knowledge base blocks via API by sending curl commands to HTTP endpoints like /api/block/getBlockKramdown, using a configured SIYUAN_TOKEN and SIYUAN_URL for authentication to search, read, create, update, and delete blocks programmatically.

Can I automate daily note creation in a self-hosted SiYuan instance?

Yes, you can automate daily note creation in a self-hosted SiYuan instance by using curl to call the /api/filetree/createDocWithMd endpoint, programmatically pushing markdown content into your knowledge base workflow.

Do I need an API token to read and update documents in SiYuan?

Yes, reading and updating documents in SiYuan requires an API token. You must configure the SIYUAN_TOKEN and the SIYUAN_URL environment variables to authenticate curl requests against the SiYuan HTTP API.

What is the best way to programmatically search blocks in a PKM system?

The best way to programmatically search blocks in a PKM system is using the SiYuan HTTP API with curl, enabling full-text search, block reads, and document management operations directly from the command line for automation workflows.

Does the SiYuan API support exporting content for backups?

Yes, the SiYuan API supports exporting content for backups. By reading blocks via endpoints like /api/block/getBlockKramdown and retrieving document structures through curl, you can automate content extraction and backup processes.