Actions25
- Append Block
- Create Document
- Create Notebook
- Delete Block
- Execute SQL Query
- Export Document Markdown
- Get Block Attributes
- Get Block Kramdown
- Get Child Blocks
- Get Document ID by Path
- Get Document Path by ID
- Insert Block
- List Documents in Notebook
- List Files in Directory
- Move Document
- Prepend Block
- Push Error Message
- Push Message
- Remove Document
- Remove Notebook
- Rename Document
- Rename Notebook
- Render Sprig Template
- Set Block Attributes
- Update Block
Overview
This node integrates with the SiYuan note-taking and knowledge management system, allowing users to perform various operations on notebooks, documents, and content blocks within SiYuan. Specifically, the "Rename Notebook" operation enables changing the name of an existing notebook by specifying its unique ID and the new desired name.
Use cases for this node include automating notebook organization workflows, renaming notebooks based on external triggers or naming conventions, and managing large collections of notes programmatically.
For example, you might use this node to rename a project notebook after a project phase completes or to standardize notebook names across a team.
Properties
| Name | Meaning |
|---|---|
| Notebook ID | The unique identifier of the SiYuan notebook you want to rename. |
| New Name for Notebook | The new name to assign to the specified notebook. |
Output
The output is a JSON object representing the result of the rename operation. Typically, it will contain success confirmation or details about the renamed notebook as returned by the SiYuan API client. If the operation fails, the output may contain an error message.
No binary data is produced by this operation.
Dependencies
- Requires an active connection to the SiYuan API via an API URL and an API authentication token.
- The node depends on a SiYuan API client library bundled with the node implementation.
- Proper credentials must be configured in n8n to authenticate requests to the SiYuan server.
Troubleshooting
- Missing Credentials: If the API URL or token is not set, the node will throw a "Credentials missing!" error. Ensure that the required API credentials are properly configured in n8n.
- Invalid Notebook ID: Providing an incorrect or non-existent notebook ID will likely cause the API call to fail. Verify the notebook ID before running the node.
- Permission Issues: Insufficient permissions on the SiYuan server for renaming notebooks can cause errors. Confirm that the API token has adequate rights.
- Unsupported Operation Error: This node supports only predefined operations; if the operation parameter is incorrectly set, an error indicating unsupported operation will occur.