skills.rest
BermudaLocals
BermudaLocalsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

siyuan

Manage blocks and documents in a self-hosted SiYuan knowledge base via its API.

1|1|Updated Apr 26, 2026
Search Tags:#authentication#api#notes#blocks#curl#knowledge-base#siyuan
One-click install
npx skills add https://github.com/BermudaLocals/hermes-agent-lite --skill siyuan-bermudalocals
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/BermudaLocals/hermes-agent-lite/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/BermudaLocals/hermes-agent-lite --skill siyuan-bermudalocals

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SiYuan Note API provides a programmatic way to search, read, create, update, and delete blocks and documents in a self-hosted knowledge base via curl and an API token.

Core Features & Use Cases

  • Search and read blocks, read block content in Kramdown, list notebooks and documents, and manage documents and notebooks via the SiYuan API.
  • Create, update, append, rename blocks and documents, and export content as Markdown for integration with external tools.
  • Use cases include PKM automation, knowledge-base maintenance, and scripted workflows that synchronize notes across notebooks.

Quick Start

Authenticate with your SiYuan instance using SIYUAN_TOKEN and SIYUAN_URL, then create a sample document using the API.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate creating and updating notes in a SiYuan knowledge base?▼

Search, read, create, and delete SiYuan blocks via API endpoints like block/getBlockKramdown and filetree/createDocWithMd, authenticating requests using your SIYUAN_TOKEN and SIYUAN_URL for programmatic knowledge-base management.

Can I use curl to export Markdown content from my SiYuan notebooks?▼

Yes, you can use curl to call the export/exportMdContent endpoint with your API token to export documents and blocks from your SiYuan notebooks as Markdown content for external tool integration.

What do I need to authenticate API requests to a self-hosted SiYuan instance?▼

To authenticate SiYuan API requests, you need to configure your SIYUAN_URL and provide a valid SIYUAN_TOKEN in your curl headers, ensuring secure access to read and write block data within your self-hosted knowledge base.

What is the best way to append blocks to existing documents in SiYuan programmatically?▼

The best way to append blocks programmatically is using the block/appendBlock API endpoint via curl, allowing you to add new content to existing SiYuan documents while maintaining your PKM automation workflows.

Does the SiYuan API support searching and listing notebooks for knowledge-base maintenance?▼

Yes, the SiYuan API supports knowledge-base maintenance by providing endpoints like notebook/lsNotebooks to list notebooks and search functionalities to locate specific blocks across your self-hosted documents.

Why use Kramdown when reading block content from the SiYuan API?▼

Reading block content via the block/getBlockKramdown endpoint returns SiYuan's native Kramdown format, preserving structural metadata and block relationships that standard Markdown would lose during automated knowledge-base synchronization.

Related Skills

Explore More Content & Communication Skills→
markwang2658markwang2658
31

siyuan

Manage SiYuan blocks and documents via curl against a self-hosted instance.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
s-hiraokus-hiraoku
21

firecrawl-api

Extract web content via Firecrawl API using curl requests.

Community
Basic
heysuhasheysuhas
2

siyuan

Manage SiYuan Note blocks and documents via authenticated POST requests.

Community
Intermediate