SiYuan icon

SiYuan

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

Database → List

AI-generated

Overview

This node interacts with the SiYuan API to manage databases within the SiYuan workspace. Specifically, for the 'Database' resource with the 'List' operation, it retrieves and lists databases (AttributeView blocks) managed in SiYuan. This is useful for workflows that need to access or display available databases for further processing or automation, such as syncing database metadata or integrating SiYuan databases with other tools.

Use Case Examples

  1. Listing all databases in SiYuan to display in a dashboard.
  2. Automating the retrieval of database information for backup or synchronization purposes.

Output

JSON

  • id - Unique identifier of the database
  • name - Name of the database
  • description - Description or metadata of the database
  • createdAt - Timestamp when the database was created
  • updatedAt - Timestamp when the database was last updated

Dependencies

  • SiYuan API URL and API Token credentials are required to authenticate and interact with the SiYuan API.

Troubleshooting

  • Ensure that the SiYuan API URL and API Token credentials are correctly set; missing or invalid credentials will cause authentication errors.
  • If the node throws an 'Unsupported resource' error, verify that the resource parameter is set to 'Database'.
  • Network connectivity issues to the SiYuan API endpoint can cause request failures; check network access and API availability.
  • If the API response is empty or unexpected, verify that the SiYuan workspace contains databases and that the API token has sufficient permissions.

Discussion