SiYuan icon

SiYuan

Manage SiYuan notebooks, documents, blocks, attributes, and more. Designed for AI agent workflows.

Notebook → List

AI-generated

Overview

This node interacts with the SiYuan API to manage notebooks, including listing notebooks. It is useful for workflows that need to retrieve and process information about notebooks stored in SiYuan, such as automation tasks that organize or analyze notebook data.

Use Case Examples

  1. Listing all notebooks in a SiYuan workspace to display their names and IDs.
  2. Automating the retrieval of notebook metadata for reporting or backup purposes.

Output

JSON

  • id - Unique identifier of the notebook
  • name - Name of the notebook
  • createdAt - Timestamp when the notebook was created
  • updatedAt - Timestamp when the notebook was last updated

Dependencies

  • SiYuan API URL and API Token credentials are required for authentication.

Troubleshooting

  • Ensure that the SiYuan API URL and API Token credentials are correctly set; missing or incorrect credentials will cause authentication errors.
  • If the node throws an 'Unsupported resource' error, verify that the resource parameter is set to 'Notebook' for this operation.
  • Network connectivity issues can prevent the node from reaching the SiYuan API, resulting in request failures.

Discussion