@stablebaseline/sdk 0.4.5 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/openapi.json CHANGED
@@ -606,7 +606,7 @@
606
606
  "description": "Semantic search over the 276 AntV Infographic templates — call this FIRST when building an `infographic` diagram so you pick the right structure for the content. Describe the intent (e.g. 'compare two options', 'show a process timeline', 'pyramid of priorities', 'org hierarchy', 'flow between systems', 'parts of a whole'); results are vector-ranked. Each result has `key` (use as line 1 `infographic <key>`), `name`, `family` (list|sequence|compare|relation|chart|hierarchy|quadrant), and `description`. The result's `usage` explains the family→data-field mapping for writing the DSL.",
607
607
  "operationId": "searchInfographicTemplates",
608
608
  "tags": [
609
- "uncategorized"
609
+ "diagrams"
610
610
  ],
611
611
  "requestBody": {
612
612
  "required": false,
@@ -2586,7 +2586,7 @@
2586
2586
  "/tools/getDocument": {
2587
2587
  "post": {
2588
2588
  "summary": "getDocument",
2589
- "description": "Read a document's content with line numbers. Returns numbered lines for use with editDocument. Diagrams/images appear as OMITTED markers with metadata (type, diagramId, nlDescription) — use getDiagramInDocument(diagramId) for full DSL code, or dedicated diagram/image tools to manage them. Pass includeDiagramDsl:true to inline each diagram's DSL and versionTimestamp directly into its DIAGRAM_OMITTED marker (saves a getDiagramInDocument call when you intend to read or edit diagrams).",
2589
+ "description": "Read a document's content with line numbers. content.text lines are formatted `NNNNN<TAB>content` (cat -n style); the number+tab prefix is DISPLAY ONLY — never part of the document — so when building editDocument anchor patches, copy only the text AFTER the tab. Reads paginate by lines (offset/limit, default 200): use content.totalLines and content.nextOffset to page. document.versionTimestamp is the optimistic-lock token that every mutating document tool accepts (as versionTimestamp; the older documentVersionTimestamp name also works) — and every mutating tool returns a fresh token, so you rarely need to re-read just to keep editing. Diagrams/images appear as OMITTED markers with metadata (type, diagramId, renderStatus, nlDescription) — use getDiagramInDocument(diagramId) for full DSL code, or pass includeDiagramDsl:true to inline each diagram's DSL and versionTimestamp directly into its DIAGRAM_OMITTED marker (saves a getDiagramInDocument call when you intend to read or edit diagrams).",
2590
2590
  "operationId": "getDocument",
2591
2591
  "tags": [
2592
2592
  "documents"
@@ -2714,7 +2714,7 @@
2714
2714
  "/tools/createDocument": {
2715
2715
  "post": {
2716
2716
  "summary": "createDocument",
2717
- "description": "Create a document from CDMD markdown. Call getCdmdLanguageGuide first if unfamiliar with syntax. Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Supports @-mentioning people: embed `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.",
2717
+ "description": "Create a document from CDMD markdown (standard Markdown plus SB extensions — call getCdmdLanguageGuide if unfamiliar). The body goes in `cdmd` (`content` is accepted as an alias). Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Returns the new document's id and versionTimestamp (the optimistic-lock token for subsequent edits). Supports @-mentioning people: embed `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.",
2718
2718
  "operationId": "createDocument",
2719
2719
  "tags": [
2720
2720
  "documents"
@@ -2736,7 +2736,12 @@
2736
2736
  "type": "string"
2737
2737
  },
2738
2738
  "cdmd": {
2739
- "type": "string"
2739
+ "type": "string",
2740
+ "description": "Document body in CDMD markdown. Alias: content."
2741
+ },
2742
+ "content": {
2743
+ "type": "string",
2744
+ "description": "Alias for cdmd — provide one of the two."
2740
2745
  },
2741
2746
  "position": {
2742
2747
  "type": "number",
@@ -2748,8 +2753,7 @@
2748
2753
  }
2749
2754
  },
2750
2755
  "required": [
2751
- "projectId",
2752
- "cdmd"
2756
+ "projectId"
2753
2757
  ]
2754
2758
  }
2755
2759
  }
@@ -2833,7 +2837,7 @@
2833
2837
  "/tools/editDocument": {
2834
2838
  "post": {
2835
2839
  "summary": "editDocument",
2836
- "description": "Edit a document: the PREFERRED tool for small targeted changes. Two patch dialects — do NOT mix them in one call. (1) ANCHOR patches {oldText, newText, before?, after?} — RECOMMENDED: replace an exact snippet of existing text with new text. oldText must match the document byte-for-byte AND be unique; if it occurs more than once, either expand oldText until it is unique, or add `before`/`after` (the EXACT text immediately before/after the match) to disambiguate. A no-match returns nearby context; an ambiguous match returns the occurrence count. Anchors do NOT drift, so you don't need fresh line numbers and they survive concurrent edits. Use newText:\"\" to delete. (2) LINE patches {startLine, endLine, replacement} — 1-based and INCLUSIVE: call getDocument first for line numbers; replace line 5 with {startLine:5,endLine:5}; INSERT before line N (deleting nothing) with {startLine:N,endLine:N-1}; append to an L-line document with {startLine:L+1,endLine:L}. Line numbers are ABSOLUTE and GO STALE after ANY edit — re-call getDocument before further line patches; out-of-range patches are rejected with the current line count. versionTimestamp from getDocument is required for optimistic locking, EXCEPT when dryRun:true. Set dryRun:true to apply the patches and get the resulting text back WITHOUT saving (verify before committing — kills retry loops). Do not edit or delete DIAGRAM/IMAGE marker lines (rejected with guidance) — use dedicated diagram/image tools. To @-mention a person, insert `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->`; look up the user_id via listAssignablePrincipals. Mentioned users are notified automatically.",
2840
+ "description": "Edit a document: the PREFERRED tool for small targeted changes. Two patch dialects — do NOT mix them in one call. (1) ANCHOR patches {oldText, newText, before?, after?} — RECOMMENDED: replace an exact snippet of existing text with new text. oldText must match the document byte-for-byte AND be unique; if it occurs more than once, either expand oldText until it is unique, or add `before`/`after` (the EXACT text immediately before/after the match) to disambiguate. A no-match returns nearby context; an ambiguous match returns the occurrence count. Anchors do NOT drift, so you don't need fresh line numbers and they survive concurrent edits. Use newText:\"\" to delete. (2) LINE patches {startLine, endLine, replacement} — 1-based and INCLUSIVE: call getDocument first for line numbers; replace line 5 with {startLine:5,endLine:5}; INSERT before line N (deleting nothing) with {startLine:N,endLine:N-1}; append to an L-line document with {startLine:L+1,endLine:L}. Line numbers are ABSOLUTE and GO STALE after ANY edit — re-call getDocument before further line patches; out-of-range patches are rejected with the current line count. versionTimestamp from getDocument (or from any mutating tool's response — they all return the fresh token) is required for optimistic locking, EXCEPT when dryRun:true. If your token is stale, the error tells you who changed the document, when, and the currentVersionTimestamp — anchor patches survive concurrent edits, so retrying with that token is usually safe. Set dryRun:true to apply the patches and get the resulting text back WITHOUT saving (verify before committing — kills retry loops). IMPORTANT: getDocument displays lines as `NNNNN<TAB>content`; that prefix is display-only — oldText/before/after must contain only the content AFTER the tab. Do not edit or delete DIAGRAM/IMAGE marker lines (rejected with guidance) — use dedicated diagram/image tools. To @-mention a person, insert `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->`; look up the user_id via listAssignablePrincipals. Mentioned users are notified automatically.",
2837
2841
  "operationId": "editDocument",
2838
2842
  "tags": [
2839
2843
  "documents"
@@ -2862,7 +2866,7 @@
2862
2866
  },
2863
2867
  "versionTimestamp": {
2864
2868
  "type": "number",
2865
- "description": "Version timestamp from getDocument() for optimistic locking. Required unless dryRun:true."
2869
+ "description": "Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.)"
2866
2870
  },
2867
2871
  "dryRun": {
2868
2872
  "type": "boolean",
@@ -3015,7 +3019,7 @@
3015
3019
  "/tools/findAndReplaceTextInDocument": {
3016
3020
  "post": {
3017
3021
  "summary": "findAndReplaceTextInDocument",
3018
- "description": "Find and replace EXACT substrings in a document (NOT regex: wildcards and patterns are matched literally). Replaces EVERY occurrence and returns the replacement count; best for renames and repeated phrases. For a single targeted change at a known location, prefer editDocument (line patches with optimistic locking). Case-sensitive by default. Diagrams/images are automatically protected — only document text is affected. Note: when the `replace` value contains a `<!-- REFERENCE: {...} -->` marker (e.g. inserting a user mention), it round-trips losslessly through the editor and triggers notifications if it adds a new user mention.",
3022
+ "description": "Find and replace EXACT substrings in a document (NOT regex: wildcards and patterns are matched literally). Replaces EVERY occurrence and returns the replacement count; best for renames and repeated phrases. For a single targeted change at a known location, prefer editDocument (anchor patches). Case-sensitive by default. Diagrams/images are automatically protected — only document text is affected. Returns document.versionTimestamp (the fresh optimistic-lock token) like every other mutating tool, so you can chain straight into editDocument or the diagram tools. Pass versionTimestamp to opt into optimistic locking (optional here — whole-document find/replace is position-independent). Note: when the `replace` value contains a `<!-- REFERENCE: {...} -->` marker (e.g. inserting a user mention), it round-trips losslessly through the editor and triggers notifications if it adds a new user mention.",
3019
3023
  "operationId": "findAndReplaceTextInDocument",
3020
3024
  "tags": [
3021
3025
  "documents"
@@ -3042,6 +3046,10 @@
3042
3046
  "type": "boolean",
3043
3047
  "description": "Case-sensitive matching. Default: true."
3044
3048
  },
3049
+ "versionTimestamp": {
3050
+ "type": "number",
3051
+ "description": "Optional optimistic-lock token from getDocument() or a previous write; validated when provided. (Alias accepted: documentVersionTimestamp.)"
3052
+ },
3045
3053
  "changeSummary": {
3046
3054
  "type": "string",
3047
3055
  "description": "Version history summary."
@@ -3134,7 +3142,7 @@
3134
3142
  "/tools/getDiagramInDocument": {
3135
3143
  "post": {
3136
3144
  "summary": "getDiagramInDocument",
3137
- "description": "Get a diagram's full details including raw DSL source code. Use diagramId from DIAGRAM_OMITTED markers in getDocument output. Returns diagramCode, type, name, nlDescription, and versionTimestamp.",
3145
+ "description": "Get a diagram's full details including raw DSL source code. Use diagramId from DIAGRAM_OMITTED markers in getDocument output. Returns diagramCode, type, name, nlDescription, renderStatus/renderError, and versionTimestamp — the diagram's optimistic-lock token for updateDiagramInDocument (every diagram write also returns it fresh).",
3138
3146
  "operationId": "getDiagramInDocument",
3139
3147
  "tags": [
3140
3148
  "diagrams"
@@ -3243,7 +3251,7 @@
3243
3251
  "/tools/insertDiagramInDocument": {
3244
3252
  "post": {
3245
3253
  "summary": "insertDiagramInDocument",
3246
- "description": "Insert a new diagram into a document. Call listDiagramTypes to find your type, then getDiagramTypeGuide for DSL syntax before writing diagramCode. Always set prompt + nlDescription to describe what the diagram shows (they are its saved description) and keep them accurate. After inserting, VERIFY the render — set returnImage:true (or call getDiagramImage) to actually SEE it — and if it is wrong or ugly, correct it with updateDiagramInDocument (provide the full updated diagramCode).",
3254
+ "description": "Insert a new diagram into a document. Call listDiagramTypes to find your type, then getDiagramTypeGuide for DSL syntax before writing diagramCode. The diagramCode is COMPILE-CHECKED BY RENDERING at write time: broken DSL is rejected with the renderer's error (fix and retry), and valid DSL is rendered + thumbnailed immediately so the document displays instantly everywhere. The response tells you what happened: diagram.renderStatus ('rendered' | 'pending_render' with renderError when the renderer was unavailable), plus fresh optimistic-lock tokens — document.versionTimestamp and diagram.versionTimestamp — so you can keep editing without re-reading. Always set prompt (and ideally nlDescription) to describe what the diagram shows. To SEE the result inline set returnImage:true, or call getDiagramImage afterwards; if it is wrong or ugly, correct it with updateDiagramInDocument (provide the full updated diagramCode).",
3247
3255
  "operationId": "insertDiagramInDocument",
3248
3256
  "tags": [
3249
3257
  "diagrams"
@@ -3260,7 +3268,7 @@
3260
3268
  },
3261
3269
  "documentVersionTimestamp": {
3262
3270
  "type": "number",
3263
- "description": "Version timestamp from getDocument() for optimistic locking."
3271
+ "description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)"
3264
3272
  },
3265
3273
  "type": {
3266
3274
  "type": "string",
@@ -3340,14 +3348,9 @@
3340
3348
  },
3341
3349
  "required": [
3342
3350
  "documentId",
3343
- "documentVersionTimestamp",
3344
3351
  "type",
3345
3352
  "diagramCode",
3346
- "prompt",
3347
- "nlDescription",
3348
- "align",
3349
- "caption",
3350
- "afterLine"
3353
+ "prompt"
3351
3354
  ]
3352
3355
  }
3353
3356
  }
@@ -3431,7 +3434,7 @@
3431
3434
  "/tools/updateDiagramInDocument": {
3432
3435
  "post": {
3433
3436
  "summary": "updateDiagramInDocument",
3434
- "description": "Update a diagram's code, description, or properties. Call getDiagramTypeGuide for DSL syntax. Provide a version lock: EITHER documentVersionTimestamp (from getDocument — locks the whole document) OR diagramVersionTimestamp (from getDiagramInDocument, or getDocument with includeDiagramDsl:true — locks just THIS diagram, so two agents can edit two different diagrams in the same document concurrently without a conflict). At least one is required; diagramVersionTimestamp is preferred for concurrency. IMPORTANT: To change what the diagram visually shows, you MUST provide diagramCode with the full updated DSL source. The prompt and nlDescription fields are metadata only and do NOT change the rendered diagram. After updating, re-render with getDiagramImage to confirm it now looks right (iterate if not), and keep prompt/nlDescription in step with what the diagram now shows.",
3437
+ "description": "Update a diagram's code, description, or properties. Call getDiagramTypeGuide for DSL syntax. New diagramCode is COMPILE-CHECKED BY RENDERING at write time — broken DSL is rejected with the renderer's error — and a valid change is re-rendered + re-thumbnailed immediately (response diagram.renderStatus tells you the outcome). Provide a version lock: diagramVersionTimestamp (from getDiagramInDocument, getDocument with includeDiagramDsl:true, or any diagram write's response — PREFERRED: locks just this diagram, so concurrent edits elsewhere in the document don't conflict; bare versionTimestamp is accepted as an alias) OR documentVersionTimestamp (locks the whole document). The response returns BOTH fresh tokens for chaining. Documents carrying a legacy marker (no embedded diagramId) are upgraded automatically on update. IMPORTANT: to change what the diagram visually shows you MUST provide diagramCode with the full updated DSL source — prompt/nlDescription are metadata only. After updating, view it with getDiagramImage and keep prompt/nlDescription in step with what the diagram now shows.",
3435
3438
  "operationId": "updateDiagramInDocument",
3436
3439
  "tags": [
3437
3440
  "diagrams"
@@ -3449,7 +3452,7 @@
3449
3452
  },
3450
3453
  "diagramCode": {
3451
3454
  "type": "string",
3452
- "description": "New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts."
3455
+ "description": "New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`)."
3453
3456
  },
3454
3457
  "prompt": {
3455
3458
  "type": "string",
@@ -3494,7 +3497,7 @@
3494
3497
  },
3495
3498
  "diagramVersionTimestamp": {
3496
3499
  "type": "number",
3497
- "description": "Diagram-level optimistic lock: versionTimestamp of THIS diagram (from getDiagramInDocument, or getDocument with includeDiagramDsl:true). Pass this instead of documentVersionTimestamp to lock only this diagram, so concurrent edits to OTHER diagrams in the same document don't conflict. Preferred for multi-agent concurrency. The response returns the new diagram.diagramVersionTimestamp for chaining further edits."
3500
+ "description": "Diagram-level optimistic lock: versionTimestamp of THIS diagram (from getDiagramInDocument, getDocument with includeDiagramDsl:true, or a previous write's response). Preferred: locks only this diagram, so concurrent edits to OTHER diagrams in the same document don't conflict. (Alias accepted: versionTimestamp.) The response returns the new diagram.versionTimestamp for chaining further edits."
3498
3501
  }
3499
3502
  },
3500
3503
  "required": [
@@ -3582,7 +3585,7 @@
3582
3585
  "/tools/deleteDiagramInDocument": {
3583
3586
  "post": {
3584
3587
  "summary": "deleteDiagramInDocument",
3585
- "description": "Delete a diagram from a document.",
3588
+ "description": "Delete a diagram: removes the database record AND every reference to it in the document body — the current marker format plus legacy forms (markers without an embedded diagramId, and old plain-text `[Diagram: name]` placeholders). The response's removedFromBody says whether a marker was actually found in the body, and versionTimestamp is the document's fresh lock token.",
3586
3589
  "operationId": "deleteDiagramInDocument",
3587
3590
  "tags": [
3588
3591
  "diagrams"
@@ -3597,6 +3600,10 @@
3597
3600
  "diagramId": {
3598
3601
  "type": "string",
3599
3602
  "description": "Diagram ID from DIAGRAM_OMITTED markers."
3603
+ },
3604
+ "versionTimestamp": {
3605
+ "type": "number",
3606
+ "description": "Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.)"
3600
3607
  }
3601
3608
  },
3602
3609
  "required": [
@@ -3876,11 +3883,11 @@
3876
3883
  }
3877
3884
  }
3878
3885
  },
3879
- "/tools/designWhiteboard": {
3886
+ "/tools/autoDesignWhiteboard": {
3880
3887
  "post": {
3881
- "summary": "designWhiteboard",
3882
- "description": "Design a complete, visually polished whiteboard from a natural-language goal using the PREMIUM multi-agent pipeline (the same one the in-app assistant uses): it browses the stencil/icon library, composes the board, renders it, critiques the rendered image, and refines — far better than hand-placing shapes. COST + APPROVAL: this costs 50 credits per board and requires the user's explicit approval. Call it FIRST without `confirm` to get the exact cost + the workspace credit balance; show that to the user and only call again with `confirm: true` once they agree. If they decline (or lack credits), build the board directly with the standard whiteboard tools (addWhiteboardElements / insertWhiteboardDiagram / listWhiteboardStencils) at no extra charge. It runs in the BACKGROUND and returns immediately with a sessionId; the board fills in over 1-3 minutes. The 50 credits are refunded automatically if the design fails on our side. Optional `designProfile: 'branded-executive'` instead builds an ON-BRAND, fully-editable McKinsey-style SLIDE DECK themed by the org's brand kit (palette/fonts) — use it when the user wants polished branded business slides; it builds in-process and the board is ready on return. Optional `designProfile: 'illustrated'` instead builds an editable-illustration board: pick it for illustrated, image-based, picture-style, richly-drawn or educational explainer boards (e.g. illustrate photosynthesis, an illustrated diagram of the water cycle, a textbook-style visual). It generates a rich text-free vector illustration and overlays real, editable text labels with leader lines on top. It is gated per organisation; if it is not enabled the call returns a clear message, so fall back to the standard design. Optional `designProfile: 'image'` instead builds a single, polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes): pick 'image' when the user wants a single finished image, poster or infographic they will refine by AI mask edits rather than by moving editable shapes. It is also gated per organisation; if it is not enabled the call returns a clear message.",
3883
- "operationId": "designWhiteboard",
3888
+ "summary": "autoDesignWhiteboard",
3889
+ "description": "Auto-design a complete, visually polished whiteboard from a natural-language goal using the PREMIUM multi-agent pipeline (the same one the in-app assistant uses): it browses the stencil/icon library, composes the WHOLE board, renders it, critiques the rendered image, and refines — far better than hand-placing shapes. This is the one-shot whole-board designer; it is NOT a conversation (for a deck you can chat with and refine turn by turn use designDeckInWhiteboard, and for a refinable illustration use designIllustrationInWhiteboard). COST + APPROVAL: this costs 50 credits per board and requires the user's explicit approval. Call it FIRST without `confirm` to get the exact cost + the workspace credit balance; show that to the user and only call again with `confirm: true` once they agree. If they decline (or lack credits), build the board directly with the standard whiteboard tools (addWhiteboardElements / insertWhiteboardDiagram / listWhiteboardStencils) at no extra charge. It runs in the BACKGROUND and returns immediately with a sessionId; the board fills in over 1-3 minutes. The 50 credits are refunded automatically if the design fails on our side. Optional `designProfile: 'branded-executive'` instead builds an ON-BRAND, fully-editable McKinsey-style SLIDE DECK themed by the org's brand kit (palette/fonts) — use it when the user wants polished branded business slides; it builds in-process and the board is ready on return. Optional `designProfile: 'illustrated'` instead builds an editable-illustration board: pick it for illustrated, image-based, picture-style, richly-drawn or educational explainer boards (e.g. illustrate photosynthesis, an illustrated diagram of the water cycle, a textbook-style visual). It generates a rich text-free vector illustration and overlays real, editable text labels with leader lines on top. It is available to every organisation and costs the same flat 50 credits (credits are the only gate). Optional `designProfile: 'image'` instead builds a single, polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes): pick 'image' when the user wants a single finished image, poster or infographic they will refine by AI mask edits rather than by moving editable shapes. It is also available to every organisation at the same flat 50 credits.",
3890
+ "operationId": "autoDesignWhiteboard",
3884
3891
  "tags": [
3885
3892
  "whiteboards"
3886
3893
  ],
@@ -3921,11 +3928,25 @@
3921
3928
  "agentic",
3922
3929
  "agentic-deck"
3923
3930
  ],
3924
- "description": "Optional. 'standard' (default) = the general multi-agent design. 'agentic' = an AI-chat-style agentic slide composer that drives the whiteboard tools and self-corrects from renders, composing ONE polished slide. 'agentic-deck' = the same agentic composer run over a planned storyline, building a multi-slide deck (each slide on its own frame, tiled left to right). 'branded-executive' = an on-brand, McKinsey-style editable SLIDE DECK themed by the org's brand kit (pair with brandKitId, or omit for the org default). 'illustrated' = an editable-illustration board: a rich text-free vector illustration with real editable text labels and leader lines placed on top. 'image' = a single polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes), which the user then refines with AI mask edits. 'illustrated' and 'image' are each gated per organisation; if not enabled the call returns a clear message."
3931
+ "description": "Optional. 'standard' (default) = the general multi-agent design. 'agentic' = an AI-chat-style agentic slide composer that drives the whiteboard tools and self-corrects from renders, composing ONE polished slide. 'agentic-deck' = the same agentic composer run over a planned storyline, building a multi-slide deck (each slide on its own frame, tiled left to right). 'branded-executive' = an on-brand, McKinsey-style editable SLIDE DECK themed by the org's brand kit (pair with brandKitId, or omit for the org default). 'illustrated' = an editable-illustration board: a rich text-free vector illustration with real editable text labels and leader lines placed on top. 'image' = a single polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes), which the user then refines with AI mask edits. Every profile is available to every organisation; the flat credit fee is the only gate."
3925
3932
  },
3926
3933
  "brandKitId": {
3927
3934
  "type": "string",
3928
3935
  "description": "Optional brand kit id (from listBrandKits) to theme a branded-executive deck. If omitted, the org's built-in default is used. Create one from just a logo (or a .pptx/.docx) via createBrandKit."
3936
+ },
3937
+ "sourceTranscript": {
3938
+ "type": "object",
3939
+ "description": "Design the board from a meeting transcript (exactly one of documentId or text). When set, the board is built as a 'meeting map' (topics, decisions, actions) from the transcript instead of from the goal alone. This mode is billed by transcript LENGTH — 2 credits per minute of transcript (10-minute minimum), not the flat 50; the first (unconfirmed) call returns the exact cost to relay to the user.",
3940
+ "properties": {
3941
+ "documentId": {
3942
+ "type": "string",
3943
+ "description": "The id of a Stable Baseline document holding the meeting transcript/notes to design from."
3944
+ },
3945
+ "text": {
3946
+ "type": "string",
3947
+ "description": "The raw transcript text to design from (pasted). Provide this OR documentId, not both."
3948
+ }
3949
+ }
3929
3950
  }
3930
3951
  },
3931
3952
  "required": [
@@ -4013,10 +4034,10 @@
4013
4034
  "/tools/designComponent": {
4014
4035
  "post": {
4015
4036
  "summary": "designComponent",
4016
- "description": "Design ONE reusable, on-brand SLIDE COMPONENT and add it to the org's component library so every future branded deck (designWhiteboard designProfile:'branded-executive') can use it. This is the self-improving design loop: an agent AUTHORS the component as a declarative template (a gradient/shadow/curve SVG skin + a native editable PPTX shape + reflowing bound-text slots), RENDERS it, a vision critic COMPARES the render to your brief and lists gaps, and it FIXES + re-renders until polished — then validates and stores it. Use it to grow the deck component catalogue beyond the built-ins (e.g. a 'kpi.delta' stat with an up/down arrow, a 'quote.card', a 'logo.strip'). Browse-first: if a component with this `key` already exists it is reused (pass force:true to redesign). Provide example `sampleSlots` so it can lay out real content, and a `projectId` for the small preview board it builds. Returns the stored component, the per-round critique trail, and the preview board id. It uses a few AI calls + renders (no flat credit charge); the new component is then free to reuse forever.",
4037
+ "description": "Design ONE reusable, on-brand SLIDE COMPONENT and add it to the org's component library so every future branded deck (autoDesignWhiteboard designProfile:'branded-executive') can use it. This is the self-improving design loop: an agent AUTHORS the component as a declarative template (a gradient/shadow/curve SVG skin + a native editable PPTX shape + reflowing bound-text slots), RENDERS it, a vision critic COMPARES the render to your brief and lists gaps, and it FIXES + re-renders until polished — then validates and stores it. Use it to grow the deck component catalogue beyond the built-ins (e.g. a 'kpi.delta' stat with an up/down arrow, a 'quote.card', a 'logo.strip'). Browse-first: if a component with this `key` already exists it is reused (pass force:true to redesign). Provide example `sampleSlots` so it can lay out real content, and a `projectId` for the small preview board it builds. Returns the stored component, the per-round critique trail, and the preview board id. It uses a few AI calls + renders (no flat credit charge); the new component is then free to reuse forever.",
4017
4038
  "operationId": "designComponent",
4018
4039
  "tags": [
4019
- "uncategorized"
4040
+ "whiteboards"
4020
4041
  ],
4021
4042
  "requestBody": {
4022
4043
  "required": false,
@@ -4163,7 +4184,7 @@
4163
4184
  "/tools/editWhiteboardImageRegion": {
4164
4185
  "post": {
4165
4186
  "summary": "editWhiteboardImageRegion",
4166
- "description": "Mask-edit (inpaint) one region of an image element on a whiteboard. Given the target image element id and a paint MASK (a PNG where WHITE marks the area to regenerate and BLACK is kept), it regenerates only the masked region using the prompt and replaces the image IN PLACE (same position + size). This is mainly used by the in-app image-board mask editor for boards designed with designProfile:'image'. It costs a small flat credit charge (refunded automatically if the edit fails on our side). It is gated per organisation behind the same 'whiteboard_design_image' feature as the image design profile; if that is not enabled the call returns a clear message.",
4187
+ "description": "Mask-edit (inpaint) one region of an image element on a whiteboard. Given the target image element id and a paint MASK (a PNG where WHITE marks the area to regenerate and BLACK is kept), it regenerates only the masked region using the prompt and replaces the image IN PLACE (same position + size). This is mainly used by the in-app image-board mask editor for boards designed with designProfile:'image'. It is available to every organisation; the small flat credit charge is the only gate (refunded automatically if the edit fails on our side).",
4167
4188
  "operationId": "editWhiteboardImageRegion",
4168
4189
  "tags": [
4169
4190
  "whiteboards"
@@ -4281,13 +4302,13 @@
4281
4302
  }
4282
4303
  }
4283
4304
  },
4284
- "/tools/designDeck": {
4305
+ "/tools/designDeckInWhiteboard": {
4285
4306
  "post": {
4286
- "summary": "designDeck",
4287
- "description": "Create or refine a slide deck on a whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReply for the result. Use for building or editing slide decks / presentations. The deck lives in a whiteboard, so it needs an existing whiteboard documentId: if you do not have one, create it first with createWhiteboard and pass its documentId here. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits and an edit 10; a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage. Export the finished deck with exportFromWhiteboard.",
4288
- "operationId": "designDeck",
4307
+ "summary": "designDeckInWhiteboard",
4308
+ "description": "Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits and an edit 10; a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage. Export the finished deck with exportFromWhiteboard.",
4309
+ "operationId": "designDeckInWhiteboard",
4289
4310
  "tags": [
4290
- "uncategorized"
4311
+ "whiteboards"
4291
4312
  ],
4292
4313
  "requestBody": {
4293
4314
  "required": false,
@@ -4298,7 +4319,7 @@
4298
4319
  "properties": {
4299
4320
  "documentId": {
4300
4321
  "type": "string",
4301
- "description": "The whiteboard to design into. REQUIRED: the deck lives in this whiteboard. Create one first with createWhiteboard if you do not already have its id."
4322
+ "description": "The whiteboard the deck lives in. REQUIRED: a deck cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the deck in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board."
4302
4323
  },
4303
4324
  "message": {
4304
4325
  "type": "string",
@@ -4306,7 +4327,7 @@
4306
4327
  },
4307
4328
  "sessionId": {
4308
4329
  "type": "string",
4309
- "description": "The design conversation to continue, as returned by an earlier designDeck call. Pass it together with message to answer a question, make an edit, or send a follow-up. Omit on the very first call to start a new conversation."
4330
+ "description": "The design conversation to continue, as returned by an earlier designDeckInWhiteboard call. Pass it together with message to answer a question, make an edit, or send a follow-up. Omit on the very first call to start a new conversation."
4310
4331
  },
4311
4332
  "deckId": {
4312
4333
  "type": "string",
@@ -4448,13 +4469,13 @@
4448
4469
  }
4449
4470
  }
4450
4471
  },
4451
- "/tools/getDeckReply": {
4472
+ "/tools/designIllustrationInWhiteboard": {
4452
4473
  "post": {
4453
- "summary": "getDeckReply",
4454
- "description": "Get the design agent's reply after calling designDeck: the status (thinking/building/ready) and EITHER the finished deck (slide count + preview) OR a clarifying question to answer (call designDeck with the sessionId + your answer). Poll until ready or a question appears. Give it the whiteboard documentId and the deckId (both returned by designDeck). It returns the build status ('generating' while working, 'ready' when the deck is finished, 'failed' if it failed) plus, once ready, the slide count and a thumbnail image URL. IMPORTANT for the conversation: if the agent asked a CLARIFYING QUESTION instead of doing the work, this returns awaitingUser:true with pendingQuestion (and assistantMessage) — relay that question to the user, then call designDeck again with the same sessionId and the user's answer as message to continue. It also returns the full conversation (history + status + pending question). A turn usually takes about 1 to 3 minutes, so poll every 15 to 30 seconds until it is 'ready' or awaitingUser is true. When ready, the deck has already been placed on the whiteboard; you can also export it with exportFromWhiteboard. If a turn failed or produced no change, the user was not charged.",
4455
- "operationId": "getDeckReply",
4474
+ "summary": "designIllustrationInWhiteboard",
4475
+ "description": "Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the illustration designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. COST + APPROVAL: a build costs 50 credits and an edit 10; a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the illustration's id), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage.",
4476
+ "operationId": "designIllustrationInWhiteboard",
4456
4477
  "tags": [
4457
- "uncategorized"
4478
+ "whiteboards"
4458
4479
  ],
4459
4480
  "requestBody": {
4460
4481
  "required": false,
@@ -4465,16 +4486,62 @@
4465
4486
  "properties": {
4466
4487
  "documentId": {
4467
4488
  "type": "string",
4468
- "description": "The whiteboard that hosts the deck."
4489
+ "description": "The whiteboard the illustration lives in. REQUIRED: an illustration cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the illustration in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board."
4490
+ },
4491
+ "message": {
4492
+ "type": "string",
4493
+ "description": "This turn's message in plain language: the illustration brief on the first turn, a change instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call."
4494
+ },
4495
+ "sessionId": {
4496
+ "type": "string",
4497
+ "description": "The design conversation to continue, as returned by an earlier designIllustrationInWhiteboard call. Pass it together with message to answer a question, make a change, or send a follow-up. Omit on the very first call to start a new conversation."
4469
4498
  },
4470
4499
  "deckId": {
4471
4500
  "type": "string",
4472
- "description": "The deck to poll, as returned by designDeck."
4501
+ "description": "Optional. An existing illustration to continue refining (usually you pass sessionId instead; when both are given the session's illustration wins). The id is called deckId because illustrations and decks share the same conversation spine."
4502
+ },
4503
+ "title": {
4504
+ "type": "string",
4505
+ "description": "Optional title. If omitted, a clear one is derived from the brief."
4506
+ },
4507
+ "brandKitId": {
4508
+ "type": "string",
4509
+ "description": "Optional brand kit id (from listBrandKits) to colour-condition the illustration. If omitted, the organisation's effective brand is used."
4510
+ },
4511
+ "attachments": {
4512
+ "type": "array",
4513
+ "description": "Optional reference images for THIS turn (up to 8; images only). The agent lifts palette, layout, and tone from them (it does not pixel-copy). Non-image attachments are ignored.",
4514
+ "items": {
4515
+ "type": "object",
4516
+ "description": "One reference image: give a public url, OR base64 data plus its mediaType.",
4517
+ "properties": {
4518
+ "url": {
4519
+ "type": "string",
4520
+ "description": "A public https URL to the image."
4521
+ },
4522
+ "data": {
4523
+ "type": "string",
4524
+ "description": "The image as base64 (no data: prefix). Provide mediaType alongside it."
4525
+ },
4526
+ "mediaType": {
4527
+ "type": "string",
4528
+ "description": "The image MIME type, e.g. 'image/png' or 'image/jpeg'."
4529
+ },
4530
+ "name": {
4531
+ "type": "string",
4532
+ "description": "Optional human-readable name for the image."
4533
+ }
4534
+ }
4535
+ }
4536
+ },
4537
+ "confirm": {
4538
+ "type": "boolean",
4539
+ "description": "Set true ONLY after the user has approved the cost (50 for a build, 10 for an edit). Leave unset/false on the first call of a turn to receive the cost quote plus balance. A clarifying question turn is never charged."
4473
4540
  }
4474
4541
  },
4475
4542
  "required": [
4476
4543
  "documentId",
4477
- "deckId"
4544
+ "message"
4478
4545
  ]
4479
4546
  }
4480
4547
  }
@@ -4555,11 +4622,11 @@
4555
4622
  }
4556
4623
  }
4557
4624
  },
4558
- "/tools/designInWhiteboard": {
4625
+ "/tools/getDeckReplyInWhiteboard": {
4559
4626
  "post": {
4560
- "summary": "designInWhiteboard",
4561
- "description": "DEPRECATED — use designDeck instead. This tool no longer designs anything; it returns a short message pointing you at designDeck (to build or edit a slide deck on a whiteboard) or at createWhiteboard + addWhiteboardElements (for manual whiteboard content). It has NO side effects and runs no design. It is kept only so existing callers get a clear message; it will be upgraded in a future update.",
4562
- "operationId": "designInWhiteboard",
4627
+ "summary": "getDeckReplyInWhiteboard",
4628
+ "description": "Get the design agent's reply after calling designDeckInWhiteboard OR designIllustrationInWhiteboard: the status (thinking/building/ready) and EITHER the finished result (a deck's slide count + preview, or the placed illustration) OR a clarifying question to answer (call the SAME tool you started with, passing the sessionId + your answer). Poll until ready or a question appears. Give it the whiteboard documentId and the deckId (both returned by the tool you called). It returns the build status ('generating' while working, 'ready' when finished, 'failed' if it failed) plus, once ready, the slide count and a thumbnail image URL. IMPORTANT for the conversation: if the agent asked a CLARIFYING QUESTION instead of doing the work, this returns awaitingUser:true with pendingQuestion (and assistantMessage) — relay that question to the user, then call the SAME design tool again with the same sessionId and the user's answer as message to continue. It also returns the full conversation (history + status + pending question). A turn usually takes about 1 to 3 minutes, so poll every 15 to 30 seconds until it is 'ready' or awaitingUser is true. When ready, the deck or illustration has already been placed on the whiteboard; a deck can also be exported with exportFromWhiteboard. If a turn failed or produced no change, the user was not charged.",
4629
+ "operationId": "getDeckReplyInWhiteboard",
4563
4630
  "tags": [
4564
4631
  "whiteboards"
4565
4632
  ],
@@ -4572,13 +4639,17 @@
4572
4639
  "properties": {
4573
4640
  "documentId": {
4574
4641
  "type": "string",
4575
- "description": "Ignored. Deprecated tool — use designDeck."
4642
+ "description": "The whiteboard that hosts the deck or illustration (it lives inside the board). REQUIRED."
4576
4643
  },
4577
- "message": {
4644
+ "deckId": {
4578
4645
  "type": "string",
4579
- "description": "Ignored. Deprecated tool — use designDeck."
4646
+ "description": "The deck or illustration to poll, as returned by designDeckInWhiteboard or designIllustrationInWhiteboard."
4580
4647
  }
4581
- }
4648
+ },
4649
+ "required": [
4650
+ "documentId",
4651
+ "deckId"
4652
+ ]
4582
4653
  }
4583
4654
  }
4584
4655
  }
@@ -4658,11 +4729,11 @@
4658
4729
  }
4659
4730
  }
4660
4731
  },
4661
- "/tools/editInWhiteboard": {
4732
+ "/tools/exportFromWhiteboard": {
4662
4733
  "post": {
4663
- "summary": "editInWhiteboard",
4664
- "description": "DEPRECATED — use designDeck instead. An edit is just another turn in the design conversation, and designDeck handles build AND edit. This tool no longer edits anything; it returns a short message pointing you at designDeck. It has NO side effects and runs no design. It is kept only so existing callers get a clear message; it will be upgraded in a future update.",
4665
- "operationId": "editInWhiteboard",
4734
+ "summary": "exportFromWhiteboard",
4735
+ "description": "Export a design that lives in a whiteboard to an editable PowerPoint (PPTX), PDF, PNG images, or raw HTML. Give it the whiteboard documentId and the designId (the deck). kind:'deck' (default) renders the finished deck via the export worker: 'pptx' = native, fully-editable PowerPoint (real shapes and text, not screenshots); 'pdf' = vector, one page per slide; 'png' = one image per slide (returned as a base64 array); 'html' = the self-contained deck HTML. Returns the file as base64 in data (pptx/pdf/html) or per-slide base64 in slides (png). The design must be finished; one that is still generating, failed, or archived returns a clear message.",
4736
+ "operationId": "exportFromWhiteboard",
4666
4737
  "tags": [
4667
4738
  "whiteboards"
4668
4739
  ],
@@ -4675,17 +4746,38 @@
4675
4746
  "properties": {
4676
4747
  "documentId": {
4677
4748
  "type": "string",
4678
- "description": "Ignored. Deprecated tool — use designDeck."
4749
+ "description": "The whiteboard that hosts the design."
4679
4750
  },
4680
4751
  "designId": {
4681
4752
  "type": "string",
4682
- "description": "Ignored. Deprecated tool — use designDeck."
4753
+ "description": "The design to export (the deck id), as returned by designDeckInWhiteboard."
4754
+ },
4755
+ "kind": {
4756
+ "type": "string",
4757
+ "enum": [
4758
+ "deck"
4759
+ ],
4760
+ "description": "Which engine. 'deck' (default)."
4761
+ },
4762
+ "format": {
4763
+ "type": "string",
4764
+ "enum": [
4765
+ "pptx",
4766
+ "pdf",
4767
+ "png",
4768
+ "html"
4769
+ ],
4770
+ "description": "Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one base64 image per slide; 'html' = the design's self-contained HTML."
4683
4771
  },
4684
- "instruction": {
4772
+ "brandKitId": {
4685
4773
  "type": "string",
4686
- "description": "Ignored. Deprecated tool — use designDeck."
4774
+ "description": "Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary)."
4687
4775
  }
4688
- }
4776
+ },
4777
+ "required": [
4778
+ "documentId",
4779
+ "designId"
4780
+ ]
4689
4781
  }
4690
4782
  }
4691
4783
  }
@@ -4765,11 +4857,11 @@
4765
4857
  }
4766
4858
  }
4767
4859
  },
4768
- "/tools/exportFromWhiteboard": {
4860
+ "/tools/startMeetingScribe": {
4769
4861
  "post": {
4770
- "summary": "exportFromWhiteboard",
4771
- "description": "Export a design that lives in a whiteboard to an editable PowerPoint (PPTX), PDF, PNG images, or raw HTML. Give it the whiteboard documentId and the designId (the deck). kind:'deck' (default) renders the finished deck via the export worker: 'pptx' = native, fully-editable PowerPoint (real shapes and text, not screenshots); 'pdf' = vector, one page per slide; 'png' = one image per slide (returned as a base64 array); 'html' = the self-contained deck HTML. Returns the file as base64 in data (pptx/pdf/html) or per-slide base64 in slides (png). The design must be finished; one that is still generating, failed, or archived returns a clear message.",
4772
- "operationId": "exportFromWhiteboard",
4862
+ "summary": "startMeetingScribe",
4863
+ "description": "Invite the Stable Baseline Meeting Scribe bot to a LIVE meeting (Zoom, Google Meet, Microsoft Teams, or Webex) so it paints a live, editable whiteboard of the conversation as it happens: sticky notes and topic clusters, an agenda that ticks itself off, and decisions and actions pinned to rails, on a real board the team keeps working in afterwards. The bot transcribes only and stores no recording. WHITEBOARD IS REQUIRED: the scribe always paints an existing whiteboard, so documentId (the whiteboard's id) is required. If you do not have a whiteboard id, ASK THE USER which whiteboard to use; do not create one automatically. COST + APPROVAL: it bills 2 credits per minute in 5-minute blocks while it runs (a 60-minute meeting is about 120 credits; hard cap 180 minutes), and it needs the user's explicit approval. Call FIRST without confirm to get the exact quote plus the workspace balance, show that to the user, and only call again with confirm:true once they agree. Available on the Pro and Enterprise plans. It returns immediately with a sessionId; poll getMeetingScribeStatus to watch it join and paint, and stopMeetingScribe to end it. The user can also just remove the bot from the meeting to stop it.",
4864
+ "operationId": "startMeetingScribe",
4773
4865
  "tags": [
4774
4866
  "whiteboards"
4775
4867
  ],
@@ -4782,37 +4874,46 @@
4782
4874
  "properties": {
4783
4875
  "documentId": {
4784
4876
  "type": "string",
4785
- "description": "The whiteboard that hosts the design."
4877
+ "description": "The whiteboard the scribe paints into. REQUIRED: a meeting scribe always paints an existing board. If you do not have a whiteboard id, ask the user which whiteboard to use; never create one automatically."
4786
4878
  },
4787
- "designId": {
4879
+ "meetingUrl": {
4788
4880
  "type": "string",
4789
- "description": "The design to export (the deck id), as returned by designInWhiteboard."
4881
+ "description": "The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected."
4790
4882
  },
4791
- "kind": {
4792
- "type": "string",
4793
- "enum": [
4794
- "deck"
4795
- ],
4796
- "description": "Which engine. 'deck' (default)."
4883
+ "agenda": {
4884
+ "type": "array",
4885
+ "description": "Optional agenda pre-drawn on the board as a left rail; each item gets a status sticker (pending, active, done) as the conversation reaches it. Omit to let the rail build itself from the topics that emerge.",
4886
+ "items": {
4887
+ "type": "object",
4888
+ "description": "One agenda item.",
4889
+ "properties": {
4890
+ "label": {
4891
+ "type": "string",
4892
+ "description": "The agenda item text."
4893
+ },
4894
+ "id": {
4895
+ "type": "string",
4896
+ "description": "Optional stable id; one is minted if omitted."
4897
+ }
4898
+ },
4899
+ "required": [
4900
+ "label"
4901
+ ]
4902
+ }
4797
4903
  },
4798
- "format": {
4799
- "type": "string",
4800
- "enum": [
4801
- "pptx",
4802
- "pdf",
4803
- "png",
4804
- "html"
4805
- ],
4806
- "description": "Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one base64 image per slide; 'html' = the design's self-contained HTML."
4904
+ "settings": {
4905
+ "type": "object",
4906
+ "description": "Optional per-meeting settings: { language (BCP-47, e.g. 'en'), sttProvider ('assemblyai' default, or 'captions'), presentMode ('off' default, or 'camera'/'screenshare' to stream the live board back into the meeting), botName (override the default '{Org} Scribe (Stable Baseline)') }.",
4907
+ "additionalProperties": true
4807
4908
  },
4808
- "brandKitId": {
4809
- "type": "string",
4810
- "description": "Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary)."
4909
+ "confirm": {
4910
+ "type": "boolean",
4911
+ "description": "Set true ONLY after the user has approved the per-minute cost. Leave unset/false on the first call to receive the quote plus balance."
4811
4912
  }
4812
4913
  },
4813
4914
  "required": [
4814
4915
  "documentId",
4815
- "designId"
4916
+ "meetingUrl"
4816
4917
  ]
4817
4918
  }
4818
4919
  }
@@ -4893,11 +4994,11 @@
4893
4994
  }
4894
4995
  }
4895
4996
  },
4896
- "/tools/getDesignStatusInWhiteboard": {
4997
+ "/tools/getMeetingScribeStatus": {
4897
4998
  "post": {
4898
- "summary": "getDesignStatusInWhiteboard",
4899
- "description": "DEPRECATED — use getDeckReply instead. This tool no longer reads any status; it returns a short message pointing you at getDeckReply (poll it after calling designDeck to get the agent's reply — the deck, or a clarifying question). It has NO side effects. It is kept only so existing callers get a clear message; it will be upgraded in a future update.",
4900
- "operationId": "getDesignStatusInWhiteboard",
4999
+ "summary": "getMeetingScribeStatus",
5000
+ "description": "Get a meeting scribe's status after startMeetingScribe: the session state (joining, in the waiting room, live in the call, paused, ending, ended, or failed), the live activity feed of what the scribe has painted, and the board it is painting. Give it the sessionId returned by startMeetingScribe. Poll every 15 to 30 seconds while the meeting runs. When the meeting ends the board holds the finished 'meeting map' (topics, decisions, actions, and a summary).",
5001
+ "operationId": "getMeetingScribeStatus",
4901
5002
  "tags": [
4902
5003
  "whiteboards"
4903
5004
  ],
@@ -4908,15 +5009,14 @@
4908
5009
  "schema": {
4909
5010
  "type": "object",
4910
5011
  "properties": {
4911
- "documentId": {
4912
- "type": "string",
4913
- "description": "Ignored. Deprecated tool — use getDeckReply."
4914
- },
4915
- "designId": {
5012
+ "sessionId": {
4916
5013
  "type": "string",
4917
- "description": "Ignored. Deprecated tool — use getDeckReply."
5014
+ "description": "The meeting scribe session to poll, as returned by startMeetingScribe."
4918
5015
  }
4919
- }
5016
+ },
5017
+ "required": [
5018
+ "sessionId"
5019
+ ]
4920
5020
  }
4921
5021
  }
4922
5022
  }
@@ -4996,11 +5096,11 @@
4996
5096
  }
4997
5097
  }
4998
5098
  },
4999
- "/tools/generateInWhiteboard": {
5099
+ "/tools/stopMeetingScribe": {
5000
5100
  "post": {
5001
- "summary": "generateInWhiteboard",
5002
- "description": "Generate an on-brand ASSET inside a whiteboard and place it on the board. kind:'illustration' (default) makes a standalone, on-brand illustration (raw pixels, the one thing native shapes and diagrams cannot make) from a plain-language prompt, colour-conditioned to the organisation's brand (or a specific brandKitId), in a clean flat-vector editorial style with NO text, letters, or numbers baked in. It is stored and dropped onto the whiteboard as an image element. Costs a small flat credit charge (refunded automatically if generation fails on our side); an identical prompt reuses a cached image at no charge. Returns the durable image URL and confirms it was placed.",
5003
- "operationId": "generateInWhiteboard",
5101
+ "summary": "stopMeetingScribe",
5102
+ "description": "Stop a running meeting scribe: the bot leaves the meeting and the board is finalised (tidy pass plus a summary frame). Give it the sessionId returned by startMeetingScribe. Billing stops at the current block; the user can also stop the scribe simply by removing the bot from the meeting.",
5103
+ "operationId": "stopMeetingScribe",
5004
5104
  "tags": [
5005
5105
  "whiteboards"
5006
5106
  ],
@@ -5011,49 +5111,13 @@
5011
5111
  "schema": {
5012
5112
  "type": "object",
5013
5113
  "properties": {
5014
- "documentId": {
5015
- "type": "string",
5016
- "description": "The whiteboard to generate the asset into (the asset is placed on this board)."
5017
- },
5018
- "prompt": {
5019
- "type": "string",
5020
- "description": "Plain-language description of the asset to generate (e.g. 'a friendly robot assistant helping a small team')."
5021
- },
5022
- "kind": {
5023
- "type": "string",
5024
- "enum": [
5025
- "illustration"
5026
- ],
5027
- "description": "What to make. 'illustration' (default)."
5028
- },
5029
- "width": {
5030
- "type": "number",
5031
- "description": "Optional output width in px (rounded to a multiple of 64, 512 to 2048). Default 1024."
5032
- },
5033
- "height": {
5034
- "type": "number",
5035
- "description": "Optional output height in px (rounded to a multiple of 64, 512 to 2048). Default 1024."
5036
- },
5037
- "style": {
5038
- "type": "string",
5039
- "description": "Optional extra style hint appended to the prompt (e.g. 'isometric', 'soft gradients, pastel')."
5040
- },
5041
- "brandKitId": {
5114
+ "sessionId": {
5042
5115
  "type": "string",
5043
- "description": "Optional brand kit id to colour-condition the asset. Defaults to the organisation's effective brand."
5044
- },
5045
- "x": {
5046
- "type": "number",
5047
- "description": "Optional x position on the board. Omit to auto-place."
5048
- },
5049
- "y": {
5050
- "type": "number",
5051
- "description": "Optional y position on the board. Omit to auto-place."
5116
+ "description": "The meeting scribe session to stop, as returned by startMeetingScribe."
5052
5117
  }
5053
5118
  },
5054
5119
  "required": [
5055
- "documentId",
5056
- "prompt"
5120
+ "sessionId"
5057
5121
  ]
5058
5122
  }
5059
5123
  }
@@ -6099,6 +6163,10 @@
6099
6163
  "fileName": {
6100
6164
  "type": "string",
6101
6165
  "description": "Optional original filename (for storage + type hinting)."
6166
+ },
6167
+ "locked": {
6168
+ "type": "boolean",
6169
+ "description": "Lock the placed image so it cannot be moved, resized, or deleted by hand (e.g. a deck-owned framed slide image that changes only via the deck conversation). Defaults to false."
6102
6170
  }
6103
6171
  },
6104
6172
  "required": [
@@ -6186,7 +6254,7 @@
6186
6254
  "/tools/insertWhiteboardDiagram": {
6187
6255
  "post": {
6188
6256
  "summary": "insertWhiteboardDiagram",
6189
- "description": "Insert a real DIAGRAM (BPMN, Diagrams-as-Code / any DSL: mermaid, d2, plantuml, graphviz, …) into a whiteboard as an editable SB diagram element. Provide documentId, diagramType (call listDiagramTypes / getDiagramTypeGuide), and source (the DSL). The diagram is rendered to an image stored like a pasted image, and its editable source is kept in a sidecar so it stays a live, re-openable diagram on the board (double-click on the canvas opens the BPMN / code / AI editor). Options: caption (label beneath it), width/height to size it, and x/y or align ('left'|'center'|'right') to place it (defaults to the right of existing content). After inserting, call getWhiteboardImage to see it and verify it rendered correctly (fix the source and re-insert if it is wrong). For a plain picture (not a diagram) use insertWhiteboardImage; to generate a diagram image WITHOUT inserting use renderDiagram.",
6257
+ "description": "Insert (or re-render in place) a real DIAGRAM (BPMN, Diagrams-as-Code / any DSL: mermaid, d2, plantuml, graphviz, …) on a whiteboard as an editable SB diagram element. Provide documentId, diagramType (call listDiagramTypes / getDiagramTypeGuide), and source (the DSL). The diagram is rendered to an image stored like a pasted image, and its editable source is kept in a sidecar so it stays a live, re-openable diagram (double-click on the canvas opens the BPMN / code / AI editor). Options: caption (label beneath it), width/height to size it (auto width caps at 480px; an explicit width may go up to 1200px), and x/y or align ('left'|'center'|'right') to place it (defaults to the right of existing content). Pass updateElementId to UPDATE an existing embedded diagram in place — re-render + replace its image and DSL while keeping the same element id and board position (used to live-edit a diagram as it evolves); if that id is not on the board yet it is created carrying that id. After inserting, call getWhiteboardImage to see it and verify it rendered correctly (fix the source and re-insert if it is wrong). For a plain picture (not a diagram) use insertWhiteboardImage; to generate a diagram image WITHOUT inserting use renderDiagram.",
6190
6258
  "operationId": "insertWhiteboardDiagram",
6191
6259
  "tags": [
6192
6260
  "whiteboards"
@@ -6216,7 +6284,7 @@
6216
6284
  },
6217
6285
  "width": {
6218
6286
  "type": "number",
6219
- "description": "Display width in px (aspect ratio preserved). Defaults to a capped natural size."
6287
+ "description": "Display width in px (aspect ratio preserved). Auto-size caps at 480px; an explicit width is honoured up to 1200px."
6220
6288
  },
6221
6289
  "height": {
6222
6290
  "type": "number",
@@ -6224,11 +6292,11 @@
6224
6292
  },
6225
6293
  "x": {
6226
6294
  "type": "number",
6227
- "description": "Top-left x on the canvas. Omit to auto-place."
6295
+ "description": "Top-left x on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given)."
6228
6296
  },
6229
6297
  "y": {
6230
6298
  "type": "number",
6231
- "description": "Top-left y on the canvas. Omit to auto-place."
6299
+ "description": "Top-left y on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given)."
6232
6300
  },
6233
6301
  "align": {
6234
6302
  "type": "string",
@@ -6238,6 +6306,17 @@
6238
6306
  "right"
6239
6307
  ],
6240
6308
  "description": "Horizontal alignment relative to existing content (placed below it). Ignored if x/y given."
6309
+ },
6310
+ "updateElementId": {
6311
+ "type": "string",
6312
+ "description": "Element id of an EXISTING embedded diagram to re-render and replace in place (keeps the element id + board position). Omit for a fresh insert. If the id is not on the board, a new element is created with it."
6313
+ },
6314
+ "fit": {
6315
+ "type": "string",
6316
+ "enum": [
6317
+ "contain"
6318
+ ],
6319
+ "description": "When 'contain' AND both width and height are given, treat width/height as a BOUNDING BOX: the diagram is scaled to its natural aspect ratio to fit inside the box (never upscaled past 1.5x natural) and centred, so it never stretches. The response's diagram.{x,y,width,height} carry the final drawn geometry. Omit for the exact width/height behaviour."
6241
6320
  }
6242
6321
  },
6243
6322
  "required": [
@@ -6723,7 +6802,7 @@
6723
6802
  "/tools/getWhiteboardImage": {
6724
6803
  "post": {
6725
6804
  "summary": "getWhiteboardImage",
6726
- "description": "Render a whiteboard to an IMAGE so you can SEE it and confirm your edits look right, then iterate — like taking a screenshot. Returns the rendered board as a viewable image attached to the result. Pass elementIds to render only specific shapes (e.g. to inspect one section/slide), region:{x,y,width,height} to capture an exact scene-coordinate window (e.g. the user's viewport), theme:'light' for the fastest single-variant render, format:'svg' for vector markup, or background to set the canvas colour. Unchanged boards return instantly from a content-keyed cache. Call this after addWhiteboardElements/updateWhiteboardScene to check layout, overlaps, labels and alignment before continuing.",
6805
+ "description": "Render a whiteboard to a raster IMAGE so you can SEE it and confirm your edits look right, then iterate — like taking a screenshot. Returns the rendered board as a viewable image attached to the result (always raster: a JPEG light variant and/or a PNG dark variant; there is no vector/SVG output, so for a vector export of a single diagram use getDiagramImage). Pass elementIds to render only specific shapes (e.g. to inspect one section/slide), region:{x,y,width,height} to capture an exact scene-coordinate window (e.g. the user's viewport), theme:'light' for the fastest single-variant render, or background to set the canvas colour. Unchanged boards return instantly from a content-keyed cache. Call this after addWhiteboardElements/updateWhiteboardScene to check layout, overlaps, labels and alignment before continuing.",
6727
6806
  "operationId": "getWhiteboardImage",
6728
6807
  "tags": [
6729
6808
  "whiteboards"
@@ -6739,14 +6818,6 @@
6739
6818
  "type": "string",
6740
6819
  "description": "The whiteboard's documentId."
6741
6820
  },
6742
- "format": {
6743
- "type": "string",
6744
- "enum": [
6745
- "png",
6746
- "svg"
6747
- ],
6748
- "description": "png (default — a viewable raster) or svg (vector markup)."
6749
- },
6750
6821
  "elementIds": {
6751
6822
  "type": "array",
6752
6823
  "items": {
@@ -7111,7 +7182,7 @@
7111
7182
  "/tools/getDiagramImage": {
7112
7183
  "post": {
7113
7184
  "summary": "getDiagramImage",
7114
- "description": "Render a diagram that ALREADY exists in a document to an IMAGE (svg/png/jpeg @1x/2x/3x) and return it — a temporary signed URL (expires in 1 hour) plus, for png/jpeg, the image inline so you can see it. Pass the diagramId (from getDocument's DIAGRAM markers or getDiagramInDocument). Reuses the diagram's cached server render when available (pixel-identical to the editor). Use renderDiagram instead to generate from raw DSL without an existing diagram.",
7185
+ "description": "Render a diagram that ALREADY exists in a document to an IMAGE (svg/png/jpeg @1x/2x/3x) and return it — a temporary signed URL (expires in 1 hour) plus, for png/jpeg, the image inline so you can see it. Pass the diagramId (from getDocument's DIAGRAM markers or getDiagramInDocument). Reuses the diagram's cached server render when available (pixel-identical to the editor); when the diagram has no cached render yet, the fresh render is persisted back to the document (persistedRender:true in the response), so reading repairs unrendered diagrams. Use renderDiagram instead to generate from raw DSL without an existing diagram.",
7115
7186
  "operationId": "getDiagramImage",
7116
7187
  "tags": [
7117
7188
  "diagrams"
@@ -7833,7 +7904,7 @@
7833
7904
  },
7834
7905
  "documentVersionTimestamp": {
7835
7906
  "type": "number",
7836
- "description": "Version timestamp from getDocument() for optimistic locking."
7907
+ "description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)"
7837
7908
  },
7838
7909
  "imageBase64": {
7839
7910
  "type": "string",
@@ -7890,7 +7961,6 @@
7890
7961
  },
7891
7962
  "required": [
7892
7963
  "documentId",
7893
- "documentVersionTimestamp",
7894
7964
  "nlDescription",
7895
7965
  "caption"
7896
7966
  ]
@@ -7976,7 +8046,7 @@
7976
8046
  "/tools/updateImageInDocument": {
7977
8047
  "post": {
7978
8048
  "summary": "updateImageInDocument",
7979
- "description": "Update image metadata (alt, caption, dimensions, alignment). Requires documentVersionTimestamp from getDocument for optimistic locking.",
8049
+ "description": "Update image metadata (alt, caption, dimensions, alignment). Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.",
7980
8050
  "operationId": "updateImageInDocument",
7981
8051
  "tags": [
7982
8052
  "images"
@@ -7994,7 +8064,7 @@
7994
8064
  },
7995
8065
  "documentVersionTimestamp": {
7996
8066
  "type": "number",
7997
- "description": "Version timestamp from getDocument() for optimistic locking."
8067
+ "description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)"
7998
8068
  },
7999
8069
  "alt": {
8000
8070
  "type": "string",
@@ -8027,8 +8097,7 @@
8027
8097
  }
8028
8098
  },
8029
8099
  "required": [
8030
- "imageId",
8031
- "documentVersionTimestamp"
8100
+ "imageId"
8032
8101
  ]
8033
8102
  }
8034
8103
  }
@@ -22902,7 +22971,7 @@
22902
22971
  "description": "Create a per-org BRAND KIT so Stable Baseline outputs come out fully on-brand. Upload your branding and it is auto-applied: pass a `logoUrl` (as little as your logo, and the vision model AUTO-EXTRACTS your palette and fonts), or an `officeUrl` (an existing .pptx/.docx, from which it extracts theme colours, fonts, logo, watermark and the embedded font files), or explicit `tokens`. The kit themes branded-executive slides AND document exports (PDF, Word, PowerPoint). Auth: can_admin_org. Tiered: free 0, pro 1, enterprise unlimited. Optionally set it as the default at a scope in one call.",
22903
22972
  "operationId": "createBrandKit",
22904
22973
  "tags": [
22905
- "uncategorized"
22974
+ "settings"
22906
22975
  ],
22907
22976
  "requestBody": {
22908
22977
  "required": false,
@@ -23039,7 +23108,7 @@
23039
23108
  "description": "List an organisation's BRAND KITS (palette/fonts/logo), newest first. Use a returned `id` as brandKitId for a design call or setDefaultBrandKit. Auth: can_admin_org.",
23040
23109
  "operationId": "listBrandKits",
23041
23110
  "tags": [
23042
- "uncategorized"
23111
+ "settings"
23043
23112
  ],
23044
23113
  "requestBody": {
23045
23114
  "required": false,
@@ -23140,7 +23209,7 @@
23140
23209
  "description": "Set or clear the default BRAND KIT at a scope: organization, workspace, or project. Defaults cascade most-specific-first (a per-board/document override beats project beats workspace beats organization). Pass brandKitId:null to clear. Auth: org owner/admin.",
23141
23210
  "operationId": "setDefaultBrandKit",
23142
23211
  "tags": [
23143
- "uncategorized"
23212
+ "settings"
23144
23213
  ],
23145
23214
  "requestBody": {
23146
23215
  "required": false,