siyuan

# SiYuan Note API Use the [SiYuan](https://github.com/siyuan-note/siyuan) kernel API via curl to search, read, create, update, and delete blocks and documents in a self-hosted knowledge base. No extra tools needed -- just curl and an API token. ## Prerequisites 1. Install and run SiYuan (desktop or Docker) 2. Get your API token: **Settings > About > API token** 3. Store it in `~/.hermes/.env`: ``` SIYUAN_TOKEN=your_token_here SIYUAN_URL=http://127.0.0.1:6806 ``` `SIYUAN_URL` defaults to `http://127.0.0.1:6806` if not set. ## API Basics All SiYuan API calls are **POST with JSON body**. Every request follows this pattern: ```bash curl -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"}' ``` Responses are JSON with this structure: ```json {"code": 0, "msg": "", "data": { ... }} ``` `code: 0` means success. Any other value is an error -- check `msg` for details. **ID format:** SiYuan IDs look like `20210808180117-6v0mkxr` (14-digit timestamp + 7 alphanumeric chars). ## Quick Reference | Operation | Endpoint | |-----------|----------| | Full-text search | `/api/search/fullTextSearchBlock` | | SQL query | `/api/query/sql` | | Read block | `/api/block/getBlockKramdown` | | Read children | `/api/block/getChildBlocks` | | Get path | `/api/filetree/getHPathByID` | | Get attributes | `/api/attr/getBlockAttrs` | | List notebooks | `/api/notebook/ls...