SiYuan icon

SiYuan

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

Document → Remove

AI-generated

Overview

This node operation removes a document from the SiYuan workspace by its unique document ID. It is useful for workflows that need to programmatically delete documents, such as cleaning up outdated or irrelevant content, or automating document management tasks within SiYuan notebooks.

Use Case Examples

  1. Automatically delete a document after processing its content.
  2. Remove documents that meet certain criteria as part of a maintenance workflow.

Properties

Name Meaning
Document ID The unique ID of the document to be removed.

Output

JSON

  • success - Indicates whether the document removal operation was successful.

Dependencies

  • SiYuan API URL and Token credentials are required to authenticate and perform the operation.

Troubleshooting

  • Ensure the Document ID is correct and exists in the SiYuan workspace to avoid errors.
  • Verify that the API URL and Token credentials are properly set and valid.
  • If the node throws an error about unsupported resource, confirm that the resource parameter is set to 'document' and operation to 'remove'.

Discussion