SiYuan icon

SiYuan

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

Document → List in Notebook

AI-generated

Summary

List all documents inside the specified notebook, retrieving their IDs, titles, filenames, and metadata from the SiYuan workspace.

Inputs

  • Notebook ID (required) — The unique ID of the notebook to list documents from.

Output shape

a list of document metadata objects

Each item represents a document in the notebook and includes fields such as id, name, title (from attributes if available), updated timestamp, and flags like isDir and isSymlink.

Examples

Example 1: List all documents in notebook

Set the Notebook ID to the desired notebook's unique identifier.

Links

Discussion