SiYuan icon

SiYuan

Manage SiYuan notebooks, documents, blocks, attributes, and more. Designed for AI agent workflows.

Block → Unfold

AI-generated

Overview

The node interacts with the SiYuan note-taking and knowledge management system, specifically to perform the 'Unfold' operation on a 'Block' resource. This operation is used to expand or reveal the content of a collapsed block within a document, allowing users to access and manipulate the detailed content inside that block. It is beneficial in workflows where managing document structure and content visibility is required, such as automated document editing, content extraction, or dynamic content presentation.

Use Case Examples

  1. Automatically unfold specific blocks in a document to extract detailed content for processing.
  2. Use in a workflow to programmatically reveal hidden sections of a note for further editing or analysis.

Properties

Name Meaning
Block ID The unique ID of the block to be unfolded. This is required to identify which block's content should be expanded.

Output

JSON

  • success - Indicates whether the unfold operation was successful.
  • data - Contains the details or updated state of the block after unfolding, if applicable.

Dependencies

  • Requires an API URL and an API token credential for authenticating with the SiYuan API.

Troubleshooting

  • Ensure that the Block ID provided is valid and corresponds to an existing block in the SiYuan workspace.
  • Verify that the API URL and token credentials are correctly configured and have the necessary permissions to perform block operations.
  • Common errors may include authentication failures, invalid block IDs, or unsupported resource/operation combinations. These can be resolved by checking credentials, input parameters, and ensuring the node is configured for the 'Block' resource with the 'Unfold' operation.

Discussion