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

Get Content (Markdown)

AI-generated

Overview

This node interacts with SiYuan documents to perform various block operations. Specifically, for the 'Get Content (Markdown)' operation, it retrieves the Markdown content of a specified block within a SiYuan document. This is useful for scenarios where you need to read or extract the content of a particular block for processing, display, or further automation.

Use Case Examples

  1. Extract the Markdown content of a note block to display it in another application.
  2. Retrieve content from a specific block to analyze or transform it in a workflow.

Properties

Name Meaning
Block ID The unique ID of the block whose Markdown content you want to retrieve.

Output

JSON

  • content - The Markdown content of the specified block.

Dependencies

  • Requires an API key credential for SiYuan API authentication to access the document blocks.

Troubleshooting

  • Ensure the Block ID is correct and exists in the SiYuan document; otherwise, the node will fail to retrieve content.
  • If the API credentials are invalid or expired, the node will not be able to connect to the SiYuan API.
  • Common error messages include 'block not found' or 'authentication failed', which indicate issues with the Block ID or API credentials respectively.

Links

Discussion