SiYuan Document Tool icon

SiYuan Document Tool

Use this tool to create, read, list, and manage documents in the SiYuan knowledge base. Use "getContent" to read a document, "create" to write a new one, "listInNotebook" to browse, or "exportMd" for full markdown export.

Actions6

Create

AI-generated

Overview

This node operation creates a new document with Markdown content in a specified notebook within the SiYuan knowledge base. It is useful for automating the creation of notes or documents programmatically, such as adding meeting notes, project documentation, or any structured content in Markdown format to a notebook.

Use Case Examples

  1. Creating a new project documentation page in a specific notebook by providing the notebook ID, document path, and Markdown content.
  2. Automating the addition of daily journal entries as Markdown documents in a designated notebook.

Properties

Name Meaning
Notebook ID The unique ID of the notebook where the new document will be created.
Document Path The path for the new document within the notebook, which must start with `/`. For example, `/My Notes/Topic`.
Markdown Content The Markdown content to be written into the new document.

Output

JSON

  • success - Indicates whether the document creation was successful.
  • id - The unique ID of the newly created document.
  • path - The path of the newly created document within the notebook.

Dependencies

  • Requires an API URL and API token credential for authenticating with the SiYuan knowledge base API.

Troubleshooting

  • Ensure the Notebook ID is correct and accessible with the provided API credentials.
  • Verify that the Document Path starts with a `/` and follows the expected format.
  • Check that the Markdown Content is properly formatted and not empty.
  • Common errors may include authentication failures, invalid notebook or document paths, and API request limits. Verify credentials and input parameters if errors occur.

Discussion