SiYuan icon

SiYuan

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

Document → Move

AI-generated

Overview

This node operation moves a document within the SiYuan workspace from its current location to a new parent location, such as a different notebook or parent document. It is useful for organizing documents by changing their hierarchical position within the workspace. For example, you can move a document to a different notebook or nest it under another document to better structure your notes or content.

Use Case Examples

  1. Moving a document with ID '12345' to a new notebook with ID '67890' to reorganize project notes.
  2. Changing the parent of a document to group related documents under a single parent document for better navigation.

Properties

Name Meaning
Document ID The unique ID of the document to be moved.
Target Parent ID The ID of the destination notebook or parent document where the document will be moved into.

Output

JSON

  • success - Indicates whether the move operation was successful.

Dependencies

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

Troubleshooting

  • Ensure that both the Document ID and Target Parent ID are valid and exist in the SiYuan workspace.
  • Verify that the API URL and token credentials are correctly set and have sufficient permissions to perform document operations.
  • Common error messages may include 'Unsupported resource' if the resource parameter is incorrect, or authentication errors if credentials are missing or invalid.

Discussion