SiYuan icon

SiYuan

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

Notebook → List

AI-generated

Summary

List all notebooks in the SiYuan workspace, returning their names and unique IDs.

Inputs

None.

Output shape

a list of notebook objects, each containing notebook metadata including id and name

The operation returns an array of notebooks; each notebook includes properties such as id and name to identify the notebook within SiYuan. No input parameters are required to list notebooks.

Examples

Example 1: Retrieve all notebooks

Select resource as 'Notebook' and operation as 'List' with no additional parameters to get the list of all notebooks.

Links

Discussion