SiYuan icon

SiYuan

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

Document → Get Document Tree

AI-generated

Summary

Retrieves the child-document tree beneath a SiYuan document, with each entry containing its ID, title, readable path, update time, and nested children. Set Max Depth to control recursion; the implementation falls back to a depth of 10 when the option is unset or zero.

Inputs

  • Document ID (required) — ID of the document whose sub-documents to retrieve.
  • Max Depth — Maximum recursion depth. The UI default is 5; when unset or zero, the implementation uses 10.

Output shape

A list of child-document records, each with id, title, hPath, updated, and children fields.

The document itself is not included. A document at the depth limit has an empty children list. Directory-read errors during traversal are treated as empty child lists; attribute or readable-path lookup errors leave the title as the ID or hPath as an empty string.

Links

Discussion