SiYuan icon

SiYuan

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

Notebook → Remove

AI-generated

Summary

Remove a notebook from SiYuan by its unique ID, permanently deleting the notebook and all its contents.

Inputs

  • Notebook ID (required) — The unique ID of the notebook to remove

Output shape

an object indicating success status and whether the notebook was found and removed

The output includes properties: success (true), found (boolean whether the notebook existed), and notebookId (the ID of the notebook removed or attempted to remove). If the notebook ID does not exist, found is false and no removal is performed.

Examples

Example 1: Removing a notebook by ID

Specify a valid notebook ID in the 'Notebook ID' field to permanently delete that notebook from SiYuan.

Links

Discussion