SiYuan icon

SiYuan

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

Document → Get Readable Path From Storage Path

AI-generated

Overview

This node operation converts an internal storage path of a document in a SiYuan notebook into a human-readable path. It is useful when you have a system-generated storage path (e.g., `/20210808180117-6v0mkxr.sy`) and want to retrieve a more understandable path representation for display or further processing.

Use Case Examples

  1. Converting internal storage paths to readable paths for document management.
  2. Displaying user-friendly document paths in a UI based on internal storage references.

Properties

Name Meaning
Notebook ID The unique ID of the notebook where the document is stored.
Storage Path The internal storage path to convert into a readable path (e.g., `/20210808180117-6v0mkxr.sy`).

Output

JSON

  • readablePath - The human-readable path corresponding to the given internal storage path.

Dependencies

  • Requires SiYuan API URL and API token credentials for authentication.

Troubleshooting

  • Ensure that the SiYuan API URL and token credentials are correctly set; otherwise, the node will throw an error indicating missing credentials.
  • If the internal storage path is invalid or does not exist, the node may return an error or an empty result.
  • Unsupported resource or operation errors may occur if the resource or operation parameters are incorrect.

Discussion