SiYuan icon

SiYuan

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

Document → Get Path by ID

AI-generated

Summary

Look up a SiYuan document’s human-readable path using its document ID. Enter the required Document ID; the operation returns the ID, the path when found, and a found flag. Lookup errors are caught and returned as not found.

Inputs

  • Document ID (required) — The unique ID of the document to look up.

Output shape

A single record

Contains id, path, and found. path is null and found is false when the lookup returns no path or raises an error; otherwise path contains the human-readable path.

Links

Discussion