siyuan

Manage SiYuan Note documents via the SiYuan Note API.

2|Updated Jun 8, 2026

Search Tags:#api #knowledge base #blockchain #document management #siyuan

Ready to run

npx skills add https://github.com/vikrant-project/devil-agent-ai-platform --skill siyuan-vikrant-project

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/vikrant-project/devil-agent-ai-platform/tree/main/agent_core/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/vikrant-project/devil-agent-ai-platform --skill siyuan-vikrant-project

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the management of SiYuan Note documents through API calls, allowing for efficient searching, reading, creating, and updating of blocks and documents.

Core Features & Use Cases

API Integration: Leverages the SiYuan Note API for seamless interaction with self-hosted knowledge bases.
Document Management: Supports operations like searching, reading, creating, updating, and deleting blocks and documents.
Use Case: Ideal for users who need to automate tasks such as updating notes, creating new documents, or organizing their knowledge base.

Quick Start

Execute the siyuan skill to perform a full-text search in your SiYuan Note database for the term 'project management'.

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 my SiYuan Note knowledge base?▼

You can automate document management in SiYuan Note by using API calls to search, read, create, update, and delete blocks and documents within your self-hosted knowledge base.

Can I use the SiYuan API to search and update specific blocks in my notes?▼

Yes, the SiYuan API supports searching and updating specific blocks in your notes, allowing you to programmatically interact with and modify individual document components.

What is needed to start interacting with SiYuan Note documents via API?▼

To start interacting with SiYuan Note documents via API, you need a running SiYuan Note instance to execute search, read, create, update, and delete operations on your knowledge base.

Does this approach support full-text search across my self-hosted knowledge base?▼

Yes, interacting with the SiYuan Note API supports full-text search across your self-hosted knowledge base, enabling you to quickly find specific terms like 'project management' within your documents.

Are there limitations when using API calls to update blocks in SiYuan Note?▼

The primary limitation is that all operations are confined to the SiYuan Note ecosystem, meaning automation is restricted to managing blocks and documents within that specific knowledge base.

What is the best way to programmatically create and organize notes in SiYuan?▼

The best way to programmatically create and organize notes in SiYuan is by leveraging the SiYuan Note API to directly create, update, and manage your documents and blocks.