SiYuan icon

SiYuan

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

Notebook → Set Configuration

AI-generated

Summary

Set or update configuration settings for a specific SiYuan notebook by providing its unique ID and a JSON object containing the desired configuration fields to update.

Inputs

  • Notebook ID (required) — The unique ID of the notebook to update.
  • Configuration (JSON) (required) — A JSON object specifying the notebook configuration fields to update. Supported fields include name, closed, refCreateSavePath, createDocNameTemplate, dailyNoteSavePath, dailyNoteTemplatePath, sortMode, and icon.

Output shape

a JSON object reflecting the updated notebook configuration as returned by the API

Requires specifying the notebookId and configuration fields in a JSON object. Merges new configuration with existing settings before updating. Errors contain suggestions based on API response.

Examples

Example 1: Update the name and icon of a notebook.

Set notebookId to the target notebook's ID and notebookConf to { "name": "New Name", "icon": "📝" }.

Links

Discussion