SiYuan Document Tool icon

SiYuan Document Tool

Use this tool to create, read, list, and manage documents in the SiYuan knowledge base. Use "getContent" to read a document, "create" to write a new one, "listInNotebook" to browse, or "exportMd" for full markdown export.

Actions6

Remove

AI-generated

Overview

This node operation permanently deletes a document in the SiYuan knowledge base by its unique document ID. It is useful for managing and cleaning up documents that are no longer needed, ensuring the knowledge base stays organized and relevant.

Use Case Examples

  1. Deleting outdated or irrelevant documents by specifying their document ID.
  2. Automating document cleanup workflows by removing documents programmatically.

Properties

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

Output

JSON

  • success - Indicates whether the document removal was successful.

Dependencies

  • Requires an API key credential for SiYuan API authentication.

Troubleshooting

  • Common issues include providing an invalid or non-existent Document ID, which may result in an error indicating the document could not be found or deleted.
  • Errors related to API authentication failure if the provided API token is invalid or expired.
  • To resolve errors, verify the Document ID is correct and ensure the API credentials are valid and have sufficient permissions to delete documents.

Links

Discussion