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

Rename

AI-generated

Overview

This node operation allows renaming an existing SiYuan notebook by specifying its unique notebook ID and the new name to assign. It is useful for managing and organizing notebooks by updating their names without creating new ones or deleting existing content.

Use Case Examples

  1. Renaming a notebook to reflect updated project titles or categories.
  2. Correcting typos or standardizing notebook names across a team.

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 if the rename operation was successful.
  • error - Error message if the rename operation 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 rename operation to fail.
  • Errors may also occur if the new name is empty or contains invalid characters.
  • If the API credentials are incorrect or expired, the node will fail to authenticate and perform the rename operation.

Links

Discussion