SiYuan icon

SiYuan

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

Notebook → Rename

AI-generated

Overview

This node operation allows renaming a notebook in the SiYuan workspace by specifying the notebook's unique ID and the new name to assign. It is useful for organizing and managing notebooks by updating their names to more meaningful or relevant titles.

Use Case Examples

  1. Renaming a notebook to reflect updated project names or topics.
  2. Changing notebook names to maintain a consistent naming convention across a workspace.

Properties

Name Meaning
Notebook ID The unique ID of the notebook to rename.
New Name The new name to assign to the notebook.

Output

JSON

  • success - Indicates whether the rename operation was successful.

Dependencies

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

Troubleshooting

  • Ensure the API URL and token credentials are correctly set; missing credentials will cause an error.
  • If the notebook ID is invalid or does not exist, the operation will fail.
  • The new name must be a valid string; empty or invalid names may cause errors.

Discussion