SiYuan Block Tool icon

SiYuan Block Tool

Use this tool to create, read, update, move, and delete content blocks within SiYuan documents. Use "append" to add content to a document, "getContentMd" to read a block, or "update" to modify existing content.

Actions6

Append

AI-generated

Overview

The SiYuan Block Tool node allows users to append Markdown content blocks to a specified parent block within SiYuan documents. This operation is useful for dynamically adding new content to existing documents or containers in SiYuan, such as appending notes, sections, or updates in Markdown format.

Use Case Examples

  1. Appending a new Markdown note to a project document by specifying the parent document's block ID and the Markdown content to add.
  2. Adding a new section to a container block within a document to expand the content structure.

Properties

Name Meaning
Parent Block ID The ID of the parent block (document or container) to add content into.
Content (Markdown) The Markdown content for the block to be appended.

Output

JSON

  • success - Indicates whether the append operation was successful.
  • id - The unique ID of the newly appended block (if returned by the API).
  • content - The Markdown content of the appended block (if returned by the API).

Dependencies

  • SiYuan API with API URL and API token credentials

Troubleshooting

  • Ensure the Parent Block ID is valid and exists in the SiYuan document to avoid errors.
  • Verify that the API credentials (URL and token) are correctly configured and have sufficient permissions.
  • Common error messages may include authentication failures, invalid block IDs, or network issues. Resolving these involves checking credentials, block IDs, and network connectivity.

Links

Discussion