SiYuan icon

SiYuan

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

Document → Get Path by ID

AI-generated

Overview

This node operation retrieves the file system path of a document in the SiYuan workspace by its unique document ID. It is useful for workflows that need to locate or reference the physical or logical storage location of a document within SiYuan, such as for document management, linking, or exporting purposes.

Use Case Examples

  1. A user wants to get the storage path of a document to create a backup or sync it with another system.
  2. An automation workflow needs to fetch the path of a document to generate a report or to link it in another application.

Properties

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

Output

JSON

  • path - The file system or 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 invalid credentials will cause authentication errors.
  • Verify the Document ID is correct and exists in the SiYuan workspace; an invalid ID may result in an error or empty response.
  • If the node throws an 'Unsupported resource' error, confirm the resource parameter is set to 'Document' and the operation to 'Get Path by ID'.

Discussion