Actions25
- Append Block
- Create Document
- Create Notebook
- Delete Block
- Execute SQL Query
- Export Document Markdown
- Get Block Attributes
- Get Block Kramdown
- Get Child Blocks
- Get Document ID by Path
- Get Document Path by ID
- Insert Block
- List Documents in Notebook
- List Files in Directory
- Move Document
- Prepend Block
- Push Error Message
- Push Message
- Remove Document
- Remove Notebook
- Rename Document
- Rename Notebook
- Render Sprig Template
- Set Block Attributes
- Update Block
Overview
The node integrates with the SiYuan note-taking and knowledge management system via its API, enabling automation of various content and document management tasks. Specifically, the Get Child Blocks operation retrieves a list of direct child blocks under a specified parent block ID. This is useful for workflows that need to analyze or manipulate the structure of notes, such as extracting sections, processing nested content, or building summaries.
Practical examples include:
- Fetching all paragraphs or list items inside a specific document section.
- Retrieving images or embedded content blocks within a note.
- Automating content reorganization by accessing child blocks before moving or updating them.
Properties
| Name | Meaning |
|---|---|
| Block ID | The unique identifier of the specific block (paragraph, list, image, or entire document) whose direct child blocks you want to retrieve. |
Output
The output JSON contains an array of objects representing the child blocks directly under the specified parent block. Each object typically includes details about the block such as its ID, type, content, and other metadata depending on the SiYuan API response.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the SiYuan API.
- The node depends on the SiYuanClient library to communicate with the SiYuan API endpoint.
- Proper configuration of the SiYuan API URL and token in the node credentials is necessary.
Troubleshooting
- Missing Credentials Error: If the API URL or token is not provided or invalid, the node will throw a "Credentials missing!" error. Ensure the API key credential is correctly set up.
- Unsupported Operation Error: If an unsupported operation name is used, the node throws an error indicating the operation is unsupported.
- Invalid Block ID: Providing an incorrect or non-existent block ID may result in empty results or API errors. Verify the block ID exists in your SiYuan workspace.
- API Connectivity Issues: Network problems or incorrect API URLs can cause request failures. Confirm network access and correct API endpoint configuration.
Links and References
- SiYuan Official Website
- SiYuan API Documentation
- Markdown Syntax Guide (for understanding block content formatting)