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

Delete

AI-generated

Overview

The SiYuan Block Tool node allows users to manage content blocks within SiYuan documents. Specifically, the 'Delete' operation permanently removes a block by its unique ID. This is useful for cleaning up or managing document content by deleting unwanted or obsolete blocks.

Use Case Examples

  1. Deleting a block by specifying its unique Block ID to remove outdated content from a document.
  2. Automating document maintenance by programmatically deleting blocks that meet certain criteria.

Properties

Name Meaning
Block ID The unique ID of the block to be deleted.

Output

JSON

  • success - Indicates whether the block deletion was successful.

Dependencies

  • Requires an API key credential for SiYuan API authentication.

Troubleshooting

  • Common issues include providing an invalid or non-existent Block ID, which will cause the deletion to fail.
  • If the API credentials are incorrect or missing, the node will not be able to authenticate and perform the deletion.
  • Error messages typically indicate if the block ID is invalid or if there is an authentication failure. Verify the block ID and API credentials to resolve these issues.

Links

Discussion