SiYuan icon

SiYuan

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

Notebook → Remove

AI-generated

Overview

This node operation removes a specified notebook from the SiYuan workspace. It is useful for managing notebooks by deleting those that are no longer needed, helping to keep the workspace organized and clutter-free. For example, a user can automate the removal of outdated or temporary notebooks as part of a workflow.

Use Case Examples

  1. Automate deletion of notebooks after project completion.
  2. Remove notebooks that are duplicates or no longer relevant.

Properties

Name Meaning
Notebook ID The unique ID of the notebook to be removed. This is a required input to identify which notebook to delete.

Output

JSON

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

Dependencies

  • Requires an API URL and API token for SiYuan API authentication.

Troubleshooting

  • Ensure the Notebook ID is correct and exists in the SiYuan workspace to avoid errors.
  • Verify that the API URL and token credentials are correctly set and valid.
  • Common error: 'SiYuan API URL and Token are required.' means credentials are missing or invalid.
  • If the resource or operation is unsupported, an error will be thrown indicating the unsupported resource.

Discussion