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

Create

AI-generated

Overview

This node allows users to create a new empty notebook in the SiYuan note-taking application. It is useful for automating the creation of notebooks as part of a workflow, such as organizing notes by project or topic automatically.

Use Case Examples

  1. Automatically create a new notebook named 'Project Alpha' when starting a new project.
  2. Create a notebook for meeting notes each time a new meeting is scheduled.

Properties

Name Meaning
Notebook Name The name for the new notebook to be created.

Output

JSON

  • success - Indicates whether the notebook creation was successful.
  • id - The unique identifier of the newly created notebook.
  • name - The name of the newly created notebook.

Dependencies

  • Requires an API key credential for SiYuan API authentication.

Troubleshooting

  • Common issues include invalid or missing API credentials, which will prevent the node from connecting to the SiYuan API.
  • Errors may occur if the notebook name is empty or contains invalid characters; ensure the notebook name is valid and non-empty.
  • If the API endpoint URL is incorrect or the SiYuan server is unreachable, the node will fail to create the notebook.

Links

Discussion