SiYuan icon

SiYuan

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

Search → Full-Text Search

AI-generated

Overview

This node performs a full-text search across all blocks in a SiYuan workspace. It is useful for finding specific content or information within the workspace by searching text across multiple blocks. For example, users can input search terms to quickly locate relevant blocks containing those terms in their notes or documents.

Use Case Examples

  1. Searching for a keyword or phrase to find all blocks containing that text in the workspace.
  2. Using the node to filter and retrieve blocks related to a specific topic or project by entering relevant search terms.

Properties

Name Meaning
Search Query The text to search for across all blocks in the workspace.

Output

JSON

  • success - Indicates whether the search operation was successful.
  • data - The search results containing blocks that match the search query.

Dependencies

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

Troubleshooting

  • Ensure that the SiYuan API URL and Token credentials are correctly set; missing or incorrect credentials will cause the node to throw an error.
  • If the resource or operation is unsupported, the node will throw an error indicating the unsupported resource.
  • Errors during the search operation will be formatted and returned if 'Continue On Fail' is enabled, allowing the workflow to proceed despite errors.

Discussion