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

List in Notebook

AI-generated

Overview

This node operation lists all documents with their titles and IDs inside a specified notebook in the SiYuan knowledge base. It is useful for browsing and managing documents within a particular notebook, allowing users to retrieve an organized list of documents for further processing or display.

Use Case Examples

  1. A user wants to see all documents stored in a specific notebook to select one for editing or review.
  2. An automation workflow needs to fetch all document titles and IDs from a notebook to generate a summary report or index.

Properties

Name Meaning
Notebook ID The unique ID of the notebook to list documents from.

Output

JSON

  • id - The unique identifier of each document in the notebook.
  • title - The title of each document in the notebook.

Dependencies

  • Requires an API key credential for SiYuan API authentication.

Troubleshooting

  • Ensure the provided Notebook ID is correct and exists in the SiYuan knowledge base; otherwise, the node may return an error or empty list.
  • If the API credentials are invalid or expired, the node will fail to connect to the SiYuan API.
  • Network issues or API downtime can cause request failures; verify connectivity and API status.

Links

  • SiYuan API Documentation - Official documentation for the SiYuan API used by this node to interact with the knowledge base.

Discussion