SiYuan icon

SiYuan

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

Notebook → Close

AI-generated

Overview

This node operation closes a specified notebook in the SiYuan workspace. It is useful for workflows that need to programmatically manage notebook states, such as closing notebooks after editing or processing to ensure data integrity or to trigger subsequent actions.

Use Case Examples

  1. Automatically close a notebook after updating its content to prevent further edits.
  2. Close a notebook as part of a cleanup process in an automated workflow.

Properties

Name Meaning
Notebook ID The unique ID of the notebook to be closed, required to identify which notebook to close.

Output

JSON

  • success - Indicates whether the notebook was successfully closed.

Dependencies

  • Requires an API URL and API token for authenticating with the SiYuan API.

Troubleshooting

  • Ensure the Notebook ID is correct and corresponds to an existing notebook in the SiYuan workspace.
  • Verify that the API URL and token credentials are correctly set and have sufficient permissions to close notebooks.
  • Common error messages may include authentication failures or invalid notebook ID errors, which can be resolved by checking credentials and input parameters.

Discussion