Interface WhiteboardToolResult

Result payload (serialized to JSON) returned from every whiteboard tool call.

interface WhiteboardToolResult {
    error?: string;
    itemId?: string;
    pageId?: string;
    success: boolean;
    summary?: string;
}

Properties

error?: string

Error description when success is false.

itemId?: string

ID of the item the tool created / mutated (when applicable).

pageId?: string

ID of the page the tool created / switched to / renamed (page tools only).

success: boolean

summary?: string

Human summary the model can narrate ("Added a sticky note …").