siyuan

Search and manage SiYuan knowledge base content via HTTP POST requests.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the manual effort of navigating and copying content from a self-hosted SiYuan knowledge base by letting you search and manage notes programmatically.

Core Features & Use Cases

  • Full-text search across blocks to quickly find relevant notes and paragraphs.
  • Block and document retrieval to read content (Kramdown/Markdown-like) and explore document structure (children blocks, paths).
  • Creation and updates for notebooks, documents, and blocks, including attributes and exports for downstream use.

Use case example: You need to find all meeting notes mentioning “release timeline”, open the top results to extract key decisions, then append a new summary paragraph back into the correct document and export it as Markdown.

Quick Start

Ask Titan to use the siyuan skill to full-text search for “release timeline” in your SiYuan instance and return the top matching blocks with their human-readable paths.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I search my SiYuan knowledge base programmatically via API?

You can search your SiYuan knowledge base programmatically by making HTTP POST requests to the full-text search endpoint. This returns matching blocks with their content and human-readable paths, requiring a valid SIYUAN_TOKEN for authentication.

Can I export SiYuan documents as Markdown through the API?

Yes, you can export SiYuan documents as Markdown through the API. The Skill supports Markdown export endpoints, allowing you to retrieve document content in Kramdown/Markdown-like format for downstream use.

How do I create and update blocks in a SiYuan notebook automatically?

To create and update blocks in a SiYuan notebook automatically, send HTTP POST requests to the block and document write endpoints. You can create documents, append paragraphs, and update block attributes using a configured SIYUAN_TOKEN.

Do I need a token to access my self-hosted SiYuan instance externally?

Yes, you need a valid SIYUAN_TOKEN to access your self-hosted SiYuan instance externally. You must also configure an optional SIYUAN_URL to point to your server, ensuring successful JSON responses with code 0.

What is the best way to retrieve meeting notes from SiYuan using an API?

The best way to retrieve meeting notes from SiYuan using an API is performing a full-text search for specific keywords. You can then read the returned block content and explore the children blocks to extract key decisions.

Why does my SiYuan API request return an error code instead of code 0?

Your SiYuan API request returns an error code instead of code 0 due to an invalid or missing SIYUAN_TOKEN, an incorrect SIYUAN_URL configuration, or malformed HTTP POST payloads. Successful operations always expect JSON responses with code 0.