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

List

AI-generated

Overview

The SiYuan Notebook Tool node allows users to manage SiYuan notebooks through various operations. Specifically, the 'List' operation retrieves and lists all notebooks along with their names and unique IDs. This is useful for users who want to view all available notebooks in their SiYuan environment, for example, to select a notebook for further actions or to audit existing notebooks.

Use Case Examples

  1. A user wants to see all notebooks they have created in SiYuan to decide which one to open or edit.
  2. An automation workflow needs to fetch the list of notebooks to display them in a dashboard or to process them further.

Properties

Name Meaning
Operation Specifies the action to perform on SiYuan notebooks. For this node, it is set to 'List' to retrieve all notebooks.

Output

JSON

  • id - The unique identifier of each notebook.
  • name - The name of each notebook.

Dependencies

  • Requires an API key credential for SiYuan API authentication to interact with the SiYuan notebook service.

Troubleshooting

  • If the node fails to list notebooks, check that the API URL and token credentials are correctly configured and valid.
  • Common errors include authentication failures or network connectivity issues to the SiYuan API endpoint.
  • Ensure the SiYuan API service is running and accessible from the environment where the node executes.

Links

  • SiYuan API Documentation - Official documentation for SiYuan API endpoints and usage, useful for understanding notebook management operations.

Discussion