Siyuan — Query and edit a SiYuan knowledge base via its API
Siyuan — Query and edit a SiYuan knowledge base via its API
Start with meaning, then move to detail.
This lesson explains Siyuan — Query and edit a SiYuan knowledge base via its API as part of Hermes internals and extension points. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Skill metadata, Reference: full SKILL.md, Prerequisites, then verify failure modes and version compatibility.
Know Python, Git, and basic project structure before changing code.
A clear outcome before you read.
- Understand Siyuan — Query and edit a SiYuan knowledge base via its API without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Skill
- An instruction bundle that teaches Hermes a repeatable workflow without necessarily adding an external service.
Query and edit a SiYuan knowledge base via its API
What does the source say, and in what order?
- 01Skill metadata
Start here to understand the core idea or structure.
- 02Reference: full SKILL.md
Read this after the foundation, then connect it to the previous step.
- 03Prerequisites
Read this after the foundation, then connect it to the previous step.
- 04API Basics
Read this after the foundation, then connect it to the previous step.
- 05Quick Reference
Read this after the foundation, then connect it to the previous step.
- 06Common Operations
Read this after the foundation, then connect it to the previous step.
- 07Search (Full-Text)
Read this after the foundation, then connect it to the previous step.
- 08Search (SQL)
Read this after the foundation, then connect it to the previous step.
- 09Read Block Content
Read this after the foundation, then connect it to the previous step.
- 10Read Child Blocks
Finish here to verify the result and special cases.
Copy only after you understand the effect.
SIYUAN_TOKEN=your_token_here
SIYUAN_URL=http://127.0.0.1:6806curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/..." \
-H "Authorization: Token $SIYUAN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"param": "value"}'{"code": 0, "msg": "", "data": { ... }}Read the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.