SiYuan icon

SiYuan

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

Document → Rename

AI-generated

Overview

This node operation renames a document in the SiYuan workspace by changing its title. It is useful for organizing and updating document titles programmatically within automated workflows, such as renaming project files, updating document names to reflect new content, or standardizing document titles across a workspace.

Use Case Examples

  1. Renaming a document to reflect a new project phase.
  2. Updating document titles to maintain consistent naming conventions.

Properties

Name Meaning
Document ID The unique ID of the document to be renamed.
New Title The new title to assign to the document.

Output

JSON

  • success - Indicates whether the rename operation was successful.

Dependencies

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

Troubleshooting

  • Ensure the Document ID is correct and exists in the SiYuan workspace to avoid errors.
  • Verify that the API URL and token credentials are properly configured and valid.
  • Common error: 'SiYuan API URL and Token are required.' means credentials are missing or invalid.
  • If the resource or operation is unsupported, an error will be thrown indicating the unsupported resource.

Discussion