SiYuan icon

SiYuan

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

Document → Get Storage Path by ID

AI-generated

Overview

This node operation retrieves the storage path of a document in the SiYuan workspace by using the document's unique ID. It is useful for workflows that need to locate where a specific document is stored within the SiYuan system, such as for file management, backup, or integration with other tools.

Use Case Examples

  1. A user wants to find the exact storage location of a document to move or back it up.
  2. An automation workflow needs to verify the storage path of a document before performing further operations like renaming or exporting.

Properties

Name Meaning
Document ID The unique ID of the document to retrieve the storage path for.

Output

JSON

  • storagePath - The storage path of the document identified by the given Document ID.

Dependencies

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

Troubleshooting

  • Ensure the SiYuan API URL and Token credentials are correctly set; missing or incorrect credentials will cause authentication errors.
  • If the document ID is invalid or does not exist, the node may return an error or empty result; verify the document ID before running the node.
  • Unsupported resource or operation errors occur if the resource or operation parameters are incorrect; ensure 'Document' resource and 'Get Storage Path by ID' operation are selected.

Discussion