siyuan

n8n nodes for siyuan

Package Information

Released: 4/11/2025
Downloads: 35 weekly / 397 monthly
Latest Version: 0.1.19
Author: psycostea

Available Nodes

Example Node
Basic Example Node
HttpBin icon
HttpBin
Interact with HttpBin API
SiYuan Tool: Append Block
AI Tool: Appends Markdown content to the end of a specified parent block (document or block) in SiYuan.
SiYuan Tool: Create Document
AI Tool: Creates a new document in SiYuan with specified content.
SiYuan Tool: Delete Block
AI Tool: Deletes an existing block in SiYuan using its ID.
SiYuan Tool: Get Block Attributes
AI Tool: Retrieves the attributes of a block by its ID.
SiYuan Tool: Get Block Kramdown
AI Tool: Retrieves the Kramdown source content of a block by its ID.
SiYuan Tool: Get Document ID by Path
AI Tool: Retrieves the document ID(s) for a given human-readable path (HPath) within a specific notebook.
SiYuan Tool: Get Document Path by ID
AI Tool: Retrieves the human-readable path (HPath) for a given document ID.
SiYuan Tool: Get Version
AI Tool: Retrieves the current version of the SiYuan system.
SiYuan Tool: Insert Block
AI Tool: Inserts Markdown content relative to another block (before, after, or as child) in SiYuan.
SiYuan Tool: Move Document(s)
AI Tool: Moves one or more documents to a new parent (notebook or document) in SiYuan using their IDs.
SiYuan Tool: Prepend Block
AI Tool: Prepends Markdown content to the beginning of a specified parent block (document or block) in SiYuan.
SiYuan Tool: Push Error Message
AI Tool: Displays an error message notification in the SiYuan UI.
SiYuan Tool: Push Message
AI Tool: Displays an informational message notification in the SiYuan UI.
SiYuan Tool: Remove Document
AI Tool: Removes an existing document in SiYuan using its ID.
SiYuan Tool: Rename Document
AI Tool: Renames an existing document in SiYuan using its ID.
SiYuan Tool: Render Sprig Template
AI Tool: Renders a template string using SiYuan's built-in Sprig template functions.
SiYuan Tool: Set Block Attributes
AI Tool: Sets custom attributes for a block using its ID. Input attributes as a JSON string.
SiYuan Tool: Execute SQL Query
AI Tool: Executes a read-only SQL query against the SiYuan database.
SiYuan Tool: Update Block
AI Tool: Updates the content of an existing block in SiYuan using its ID.

Documentation

n8n-nodes-siyuan

This is an n8n community node package. It lets you interact with the SiYuan personal knowledge management system API within your n8n workflows.

SiYuan is a privacy-first, self-hosted personal knowledge management system with a block-based editor and bidirectional linking capabilities.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Search for n8n-nodes-siyuan (Note: This is the assumed package name based on package.json, adjust if different upon publishing).

Operations

The SiYuan AI node provides the following operations:

  • Document Operations:
    • Create Document
    • Rename Document
    • Remove Document
    • Move Document
    • Get Document ID by Path
    • Get Document Path by ID
  • Block Operations:
    • Append Block
    • Prepend Block
    • Insert Block
    • Update Block
    • Delete Block
    • Get Block Kramdown
  • Attribute Operations:
    • Set Block Attributes
    • Get Block Attributes
  • SQL Operations:
    • Execute SQL Query
  • Template Operations:
    • Render Sprig Template
  • Notification Operations:
    • Push Message
    • Push Error Message
  • System Operations:
    • Get Version

Credentials

To use this node, you need to configure the SiYuan API credentials:

  1. Prerequisites:
    • Have SiYuan running and accessible from your n8n instance.
    • Enable the API in SiYuan (Settings -> About -> API Token). Note down the API Token and the API Server address (usually http://127.0.0.1:6806 if running locally).
  2. Setup in n8n:
    • Go to the 'Credentials' section in your n8n instance.
    • Click 'Add credential'.
    • Search for 'SiYuan API' and select it.
    • Enter a name for your credential (e.g., "My Local SiYuan").
    • Fill in the SiYuan API URL (e.g., http://127.0.0.1:6806).
    • Paste your SiYuan API Token into the corresponding field.
    • Save the credential.

Compatibility

  • Minimum n8n version: (Specify based on testing, likely >= 1.0)
  • Tested n8n versions: (Specify versions tested during development)
  • SiYuan API: Tested against SiYuan version (Specify SiYuan version if known, based on API docs used)

Resources

Discussion