SiYuan Notebook Tool icon

SiYuan Notebook Tool

Use this tool to manage SiYuan notebooks. Use "list" to see all notebooks and their IDs, "create" to make a new notebook, or "getConf" to read notebook settings.

Actions5

Remove

AI-generated

Overview

This node operation allows users to permanently delete a SiYuan notebook and all its contents. It is useful for managing and cleaning up notebooks that are no longer needed, ensuring that unwanted data is completely removed from the system.

Use Case Examples

  1. Deleting an old project notebook to free up space.
  2. Removing a test notebook created for temporary use.

Properties

Name Meaning
Notebook ID The unique ID of the notebook to be removed

Output

JSON

  • success - Indicates if the notebook was successfully removed
  • error - Error message if the removal failed

Dependencies

  • Requires an API key credential for SiYuan API authentication

Troubleshooting

  • Common issues include providing an invalid or non-existent notebook ID, which will cause the operation to fail.
  • If the API credentials are incorrect or expired, the node will not be able to authenticate and perform the removal.
  • Error messages typically indicate the reason for failure, such as 'notebook not found' or 'authentication failed'. Users should verify the notebook ID and API credentials to resolve these issues.

Discussion