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 API to perform various operations related to notebooks, documents, and content blocks within the SiYuan note-taking and knowledge management system. Specifically, the "Create Notebook" operation allows users to create a new, empty notebook in their SiYuan workspace.
Common scenarios for this node include automating the organization of notes by programmatically creating notebooks, managing document structures, or integrating SiYuan with other tools and workflows. For example, you might use this node to automatically create a new project notebook when a new project is started in your task management system.
Properties
| Name | Meaning |
|---|---|
| New Notebook Name | The name for the new notebook to be created |
Output
The output JSON contains the response from the SiYuan API after attempting to create the notebook. Typically, this will include details about the newly created notebook such as its unique ID and name. If the creation is successful, the output confirms success; if not, it may contain error information.
No binary data output is produced by this operation.
Dependencies
- Requires an API URL and an API token credential to authenticate with the SiYuan API.
- The node depends on the
SiYuanClientlibrary (bundled internally) to communicate with the SiYuan service. - Proper configuration of the API credentials in n8n is necessary before using this node.
Troubleshooting
- Missing Credentials: If the API URL or token is missing, the node will throw a "Credentials missing!" error. Ensure that the API key credential is properly set up in n8n.
- Unsupported Operation: If an unsupported operation is selected, the node throws an error indicating the operation is unsupported.
- API Errors: Any errors returned by the SiYuan API (e.g., invalid notebook name, permission issues) will be surfaced in the node's output. Check the error message for details.
- Network Issues: Connectivity problems to the SiYuan API endpoint can cause failures. Verify network access and correct API URL.
Links and References
- SiYuan Official Website
- SiYuan API Documentation
- Markdown Guide (for content formatting in other operations)