SiYuan icon

SiYuan

Interacts with the SiYuan API using selected operations

Overview

The node interacts with the SiYuan note-taking and knowledge management system via its API, enabling various document and block manipulations. Specifically, the "Append Block" operation adds a new content block (in Markdown or HTML format) to the end of an existing parent block, which could be a document or another container block.

This operation is useful when you want to programmatically extend documents or notes by appending additional content without overwriting existing data. For example, you might append meeting notes to a project document, add new list items to a task list, or insert supplementary information at the end of a chapter.

Properties

Name Meaning
Parent Block ID The unique identifier of the block (such as a document or list) where the new content will be appended.
Content (Markdown/HTML) The text content and formatting for the new block, provided in Markdown or HTML. This defines what will be appended.

Output

The output JSON contains the response from the SiYuan API after attempting to append the block. Typically, this includes details about the newly created block such as its ID and metadata confirming the successful addition.

If the operation fails, the output may contain an error message describing the issue.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the SiYuan API.
  • Needs an API URL and an API authentication token configured in the node credentials.
  • The user must have appropriate permissions in SiYuan to modify blocks.

Troubleshooting

  • Missing Credentials: If the API URL or token is not set, the node will throw a "Credentials missing!" error. Ensure that valid credentials are configured.
  • Invalid Parent Block ID: Providing a non-existent or incorrect parent block ID will cause the operation to fail. Verify the ID before running.
  • Malformed Content: Improperly formatted Markdown or HTML might lead to unexpected rendering or errors. Validate content syntax.
  • API Errors: Network issues or permission restrictions on the SiYuan side can cause failures. Check connectivity and user rights.
  • Unsupported Operation: Using an operation name other than those supported will result in an error indicating unsupported operation.

Links and References

Discussion