@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.
@@ -435,7 +435,7 @@ export interface paths {
435
435
  put?: never;
436
436
  /**
437
437
  * getDocument
438
- * @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).
438
+ * @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).
439
439
  */
440
440
  post: operations["getDocument"];
441
441
  delete?: never;
@@ -455,7 +455,7 @@ export interface paths {
455
455
  put?: never;
456
456
  /**
457
457
  * createDocument
458
- * @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.
458
+ * @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.
459
459
  */
460
460
  post: operations["createDocument"];
461
461
  delete?: never;
@@ -475,7 +475,7 @@ export interface paths {
475
475
  put?: never;
476
476
  /**
477
477
  * editDocument
478
- * @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.
478
+ * @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.
479
479
  */
480
480
  post: operations["editDocument"];
481
481
  delete?: never;
@@ -495,7 +495,7 @@ export interface paths {
495
495
  put?: never;
496
496
  /**
497
497
  * findAndReplaceTextInDocument
498
- * @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.
498
+ * @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.
499
499
  */
500
500
  post: operations["findAndReplaceTextInDocument"];
501
501
  delete?: never;
@@ -515,7 +515,7 @@ export interface paths {
515
515
  put?: never;
516
516
  /**
517
517
  * getDiagramInDocument
518
- * @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.
518
+ * @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).
519
519
  */
520
520
  post: operations["getDiagramInDocument"];
521
521
  delete?: never;
@@ -535,7 +535,7 @@ export interface paths {
535
535
  put?: never;
536
536
  /**
537
537
  * insertDiagramInDocument
538
- * @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).
538
+ * @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).
539
539
  */
540
540
  post: operations["insertDiagramInDocument"];
541
541
  delete?: never;
@@ -555,7 +555,7 @@ export interface paths {
555
555
  put?: never;
556
556
  /**
557
557
  * updateDiagramInDocument
558
- * @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.
558
+ * @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.
559
559
  */
560
560
  post: operations["updateDiagramInDocument"];
561
561
  delete?: never;
@@ -575,7 +575,7 @@ export interface paths {
575
575
  put?: never;
576
576
  /**
577
577
  * deleteDiagramInDocument
578
- * @description Delete a diagram from a document.
578
+ * @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.
579
579
  */
580
580
  post: operations["deleteDiagramInDocument"];
581
581
  delete?: never;
@@ -624,7 +624,7 @@ export interface paths {
624
624
  patch?: never;
625
625
  trace?: never;
626
626
  };
627
- "/tools/designWhiteboard": {
627
+ "/tools/autoDesignWhiteboard": {
628
628
  parameters: {
629
629
  query?: never;
630
630
  header?: never;
@@ -634,10 +634,10 @@ export interface paths {
634
634
  get?: never;
635
635
  put?: never;
636
636
  /**
637
- * designWhiteboard
638
- * @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.
637
+ * autoDesignWhiteboard
638
+ * @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.
639
639
  */
640
- post: operations["designWhiteboard"];
640
+ post: operations["autoDesignWhiteboard"];
641
641
  delete?: never;
642
642
  options?: never;
643
643
  head?: never;
@@ -655,7 +655,7 @@ export interface paths {
655
655
  put?: never;
656
656
  /**
657
657
  * designComponent
658
- * @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.
658
+ * @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.
659
659
  */
660
660
  post: operations["designComponent"];
661
661
  delete?: never;
@@ -675,7 +675,7 @@ export interface paths {
675
675
  put?: never;
676
676
  /**
677
677
  * editWhiteboardImageRegion
678
- * @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.
678
+ * @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).
679
679
  */
680
680
  post: operations["editWhiteboardImageRegion"];
681
681
  delete?: never;
@@ -684,7 +684,7 @@ export interface paths {
684
684
  patch?: never;
685
685
  trace?: never;
686
686
  };
687
- "/tools/designDeck": {
687
+ "/tools/designDeckInWhiteboard": {
688
688
  parameters: {
689
689
  query?: never;
690
690
  header?: never;
@@ -694,17 +694,17 @@ export interface paths {
694
694
  get?: never;
695
695
  put?: never;
696
696
  /**
697
- * designDeck
698
- * @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.
697
+ * designDeckInWhiteboard
698
+ * @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.
699
699
  */
700
- post: operations["designDeck"];
700
+ post: operations["designDeckInWhiteboard"];
701
701
  delete?: never;
702
702
  options?: never;
703
703
  head?: never;
704
704
  patch?: never;
705
705
  trace?: never;
706
706
  };
707
- "/tools/getDeckReply": {
707
+ "/tools/designIllustrationInWhiteboard": {
708
708
  parameters: {
709
709
  query?: never;
710
710
  header?: never;
@@ -714,17 +714,17 @@ export interface paths {
714
714
  get?: never;
715
715
  put?: never;
716
716
  /**
717
- * getDeckReply
718
- * @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.
717
+ * designIllustrationInWhiteboard
718
+ * @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.
719
719
  */
720
- post: operations["getDeckReply"];
720
+ post: operations["designIllustrationInWhiteboard"];
721
721
  delete?: never;
722
722
  options?: never;
723
723
  head?: never;
724
724
  patch?: never;
725
725
  trace?: never;
726
726
  };
727
- "/tools/designInWhiteboard": {
727
+ "/tools/getDeckReplyInWhiteboard": {
728
728
  parameters: {
729
729
  query?: never;
730
730
  header?: never;
@@ -734,17 +734,17 @@ export interface paths {
734
734
  get?: never;
735
735
  put?: never;
736
736
  /**
737
- * designInWhiteboard
738
- * @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.
737
+ * getDeckReplyInWhiteboard
738
+ * @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.
739
739
  */
740
- post: operations["designInWhiteboard"];
740
+ post: operations["getDeckReplyInWhiteboard"];
741
741
  delete?: never;
742
742
  options?: never;
743
743
  head?: never;
744
744
  patch?: never;
745
745
  trace?: never;
746
746
  };
747
- "/tools/editInWhiteboard": {
747
+ "/tools/exportFromWhiteboard": {
748
748
  parameters: {
749
749
  query?: never;
750
750
  header?: never;
@@ -754,17 +754,17 @@ export interface paths {
754
754
  get?: never;
755
755
  put?: never;
756
756
  /**
757
- * editInWhiteboard
758
- * @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.
757
+ * exportFromWhiteboard
758
+ * @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.
759
759
  */
760
- post: operations["editInWhiteboard"];
760
+ post: operations["exportFromWhiteboard"];
761
761
  delete?: never;
762
762
  options?: never;
763
763
  head?: never;
764
764
  patch?: never;
765
765
  trace?: never;
766
766
  };
767
- "/tools/exportFromWhiteboard": {
767
+ "/tools/startMeetingScribe": {
768
768
  parameters: {
769
769
  query?: never;
770
770
  header?: never;
@@ -774,17 +774,17 @@ export interface paths {
774
774
  get?: never;
775
775
  put?: never;
776
776
  /**
777
- * exportFromWhiteboard
778
- * @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.
777
+ * startMeetingScribe
778
+ * @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.
779
779
  */
780
- post: operations["exportFromWhiteboard"];
780
+ post: operations["startMeetingScribe"];
781
781
  delete?: never;
782
782
  options?: never;
783
783
  head?: never;
784
784
  patch?: never;
785
785
  trace?: never;
786
786
  };
787
- "/tools/getDesignStatusInWhiteboard": {
787
+ "/tools/getMeetingScribeStatus": {
788
788
  parameters: {
789
789
  query?: never;
790
790
  header?: never;
@@ -794,17 +794,17 @@ export interface paths {
794
794
  get?: never;
795
795
  put?: never;
796
796
  /**
797
- * getDesignStatusInWhiteboard
798
- * @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.
797
+ * getMeetingScribeStatus
798
+ * @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).
799
799
  */
800
- post: operations["getDesignStatusInWhiteboard"];
800
+ post: operations["getMeetingScribeStatus"];
801
801
  delete?: never;
802
802
  options?: never;
803
803
  head?: never;
804
804
  patch?: never;
805
805
  trace?: never;
806
806
  };
807
- "/tools/generateInWhiteboard": {
807
+ "/tools/stopMeetingScribe": {
808
808
  parameters: {
809
809
  query?: never;
810
810
  header?: never;
@@ -814,10 +814,10 @@ export interface paths {
814
814
  get?: never;
815
815
  put?: never;
816
816
  /**
817
- * generateInWhiteboard
818
- * @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.
817
+ * stopMeetingScribe
818
+ * @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.
819
819
  */
820
- post: operations["generateInWhiteboard"];
820
+ post: operations["stopMeetingScribe"];
821
821
  delete?: never;
822
822
  options?: never;
823
823
  head?: never;
@@ -975,7 +975,7 @@ export interface paths {
975
975
  put?: never;
976
976
  /**
977
977
  * insertWhiteboardDiagram
978
- * @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.
978
+ * @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.
979
979
  */
980
980
  post: operations["insertWhiteboardDiagram"];
981
981
  delete?: never;
@@ -1055,7 +1055,7 @@ export interface paths {
1055
1055
  put?: never;
1056
1056
  /**
1057
1057
  * getWhiteboardImage
1058
- * @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.
1058
+ * @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.
1059
1059
  */
1060
1060
  post: operations["getWhiteboardImage"];
1061
1061
  delete?: never;
@@ -1115,7 +1115,7 @@ export interface paths {
1115
1115
  put?: never;
1116
1116
  /**
1117
1117
  * getDiagramImage
1118
- * @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.
1118
+ * @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.
1119
1119
  */
1120
1120
  post: operations["getDiagramImage"];
1121
1121
  delete?: never;
@@ -1255,7 +1255,7 @@ export interface paths {
1255
1255
  put?: never;
1256
1256
  /**
1257
1257
  * updateImageInDocument
1258
- * @description Update image metadata (alt, caption, dimensions, alignment). Requires documentVersionTimestamp from getDocument for optimistic locking.
1258
+ * @description Update image metadata (alt, caption, dimensions, alignment). Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.
1259
1259
  */
1260
1260
  post: operations["updateImageInDocument"];
1261
1261
  delete?: never;
@@ -5944,7 +5944,10 @@ export interface operations {
5944
5944
  projectId: string;
5945
5945
  folderId?: string;
5946
5946
  title?: string;
5947
- cdmd: string;
5947
+ /** @description Document body in CDMD markdown. Alias: content. */
5948
+ cdmd?: string;
5949
+ /** @description Alias for cdmd — provide one of the two. */
5950
+ content?: string;
5948
5951
  /** @description Sort position within the parent folder (or project root if no folderId). When omitted, the document is appended at the end. */
5949
5952
  position?: number;
5950
5953
  /** @description Version history summary. */
@@ -6037,7 +6040,7 @@ export interface operations {
6037
6040
  folderId?: string;
6038
6041
  /** @description Sort position within the parent folder. Use to reposition a single document. For batch sibling reorder, use reorderDocuments. */
6039
6042
  position?: number;
6040
- /** @description Version timestamp from getDocument() for optimistic locking. Required unless dryRun:true. */
6043
+ /** @description Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.) */
6041
6044
  versionTimestamp?: number;
6042
6045
  /** @description If true, apply the patches and RETURN the resulting document text without saving — no version bump, no lock required. Use to preview/verify a patch before committing. Default false. */
6043
6046
  dryRun?: boolean;
@@ -6149,6 +6152,8 @@ export interface operations {
6149
6152
  replace: string;
6150
6153
  /** @description Case-sensitive matching. Default: true. */
6151
6154
  caseSensitive?: boolean;
6155
+ /** @description Optional optimistic-lock token from getDocument() or a previous write; validated when provided. (Alias accepted: documentVersionTimestamp.) */
6156
+ versionTimestamp?: number;
6152
6157
  /** @description Version history summary. */
6153
6158
  changeSummary?: string;
6154
6159
  };
@@ -6318,8 +6323,8 @@ export interface operations {
6318
6323
  content: {
6319
6324
  "application/json": {
6320
6325
  documentId: string;
6321
- /** @description Version timestamp from getDocument() for optimistic locking. */
6322
- documentVersionTimestamp: number;
6326
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
6327
+ documentVersionTimestamp?: number;
6323
6328
  /** @description Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types. */
6324
6329
  type: string;
6325
6330
  /** @description Diagram DSL code. Call getDiagramTypeGuide for syntax. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it. */
@@ -6327,16 +6332,16 @@ export interface operations {
6327
6332
  /** @description Short description of what the diagram shows (1-2 sentences). */
6328
6333
  prompt: string;
6329
6334
  /** @description Extended description of the diagram (2-4 sentences). */
6330
- nlDescription: string;
6335
+ nlDescription?: string;
6331
6336
  /**
6332
6337
  * @description Alignment.
6333
6338
  * @enum {string}
6334
6339
  */
6335
- align: "left" | "center" | "right";
6340
+ align?: "left" | "center" | "right";
6336
6341
  /** @description Caption below the diagram. */
6337
- caption: string;
6342
+ caption?: string;
6338
6343
  /** @description Insert after this line number (1-based). */
6339
- afterLine: number;
6344
+ afterLine?: number;
6340
6345
  /** @description BPMN only. Color plan: { byElementId: { ElementId: SwatchName } }. */
6341
6346
  colorPlan?: {
6342
6347
  /** @description Map of element IDs to color swatch names. */
@@ -6441,7 +6446,7 @@ export interface operations {
6441
6446
  "application/json": {
6442
6447
  /** @description Diagram ID from DIAGRAM_OMITTED markers. */
6443
6448
  diagramId: string;
6444
- /** @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. */
6449
+ /** @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>`). */
6445
6450
  diagramCode?: string;
6446
6451
  /** @description New short description (metadata only — does NOT change the rendered diagram). */
6447
6452
  prompt?: string;
@@ -6463,7 +6468,7 @@ export interface operations {
6463
6468
  };
6464
6469
  /** @description Document-level optimistic lock: versionTimestamp from getDocument(). Locks the whole document. Provide this OR diagramVersionTimestamp (at least one is required). */
6465
6470
  documentVersionTimestamp?: number;
6466
- /** @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. */
6471
+ /** @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. */
6467
6472
  diagramVersionTimestamp?: number;
6468
6473
  };
6469
6474
  };
@@ -6548,6 +6553,8 @@ export interface operations {
6548
6553
  "application/json": {
6549
6554
  /** @description Diagram ID from DIAGRAM_OMITTED markers. */
6550
6555
  diagramId: string;
6556
+ /** @description Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.) */
6557
+ versionTimestamp?: number;
6551
6558
  };
6552
6559
  };
6553
6560
  };
@@ -6781,7 +6788,7 @@ export interface operations {
6781
6788
  };
6782
6789
  };
6783
6790
  };
6784
- designWhiteboard: {
6791
+ autoDesignWhiteboard: {
6785
6792
  parameters: {
6786
6793
  query?: never;
6787
6794
  header?: never;
@@ -6802,12 +6809,19 @@ export interface operations {
6802
6809
  /** @description Set true ONLY after the user has approved the 50-credit cost. Leave unset/false on the first call to receive the cost quote + balance. */
6803
6810
  confirm?: boolean;
6804
6811
  /**
6805
- * @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.
6812
+ * @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.
6806
6813
  * @enum {string}
6807
6814
  */
6808
6815
  designProfile?: "standard" | "branded-executive" | "illustrated" | "image" | "agentic" | "agentic-deck";
6809
6816
  /** @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. */
6810
6817
  brandKitId?: string;
6818
+ /** @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. */
6819
+ sourceTranscript?: {
6820
+ /** @description The id of a Stable Baseline document holding the meeting transcript/notes to design from. */
6821
+ documentId?: string;
6822
+ /** @description The raw transcript text to design from (pasted). Provide this OR documentId, not both. */
6823
+ text?: string;
6824
+ };
6811
6825
  };
6812
6826
  };
6813
6827
  };
@@ -7075,7 +7089,7 @@ export interface operations {
7075
7089
  };
7076
7090
  };
7077
7091
  };
7078
- designDeck: {
7092
+ designDeckInWhiteboard: {
7079
7093
  parameters: {
7080
7094
  query?: never;
7081
7095
  header?: never;
@@ -7085,11 +7099,11 @@ export interface operations {
7085
7099
  requestBody?: {
7086
7100
  content: {
7087
7101
  "application/json": {
7088
- /** @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. */
7102
+ /** @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. */
7089
7103
  documentId: string;
7090
7104
  /** @description This turn's message in plain language: the design brief on the first turn, an edit 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. */
7091
7105
  message: string;
7092
- /** @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. */
7106
+ /** @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. */
7093
7107
  sessionId?: string;
7094
7108
  /** @description Optional. An existing deck to continue designing (usually you pass sessionId instead; when both are given the session's deck wins). */
7095
7109
  deckId?: string;
@@ -7188,7 +7202,7 @@ export interface operations {
7188
7202
  };
7189
7203
  };
7190
7204
  };
7191
- getDeckReply: {
7205
+ designIllustrationInWhiteboard: {
7192
7206
  parameters: {
7193
7207
  query?: never;
7194
7208
  header?: never;
@@ -7198,10 +7212,31 @@ export interface operations {
7198
7212
  requestBody?: {
7199
7213
  content: {
7200
7214
  "application/json": {
7201
- /** @description The whiteboard that hosts the deck. */
7215
+ /** @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. */
7202
7216
  documentId: string;
7203
- /** @description The deck to poll, as returned by designDeck. */
7204
- deckId: string;
7217
+ /** @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. */
7218
+ message: string;
7219
+ /** @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. */
7220
+ sessionId?: string;
7221
+ /** @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. */
7222
+ deckId?: string;
7223
+ /** @description Optional title. If omitted, a clear one is derived from the brief. */
7224
+ title?: string;
7225
+ /** @description Optional brand kit id (from listBrandKits) to colour-condition the illustration. If omitted, the organisation's effective brand is used. */
7226
+ brandKitId?: string;
7227
+ /** @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. */
7228
+ attachments?: {
7229
+ /** @description A public https URL to the image. */
7230
+ url?: string;
7231
+ /** @description The image as base64 (no data: prefix). Provide mediaType alongside it. */
7232
+ data?: string;
7233
+ /** @description The image MIME type, e.g. 'image/png' or 'image/jpeg'. */
7234
+ mediaType?: string;
7235
+ /** @description Optional human-readable name for the image. */
7236
+ name?: string;
7237
+ }[];
7238
+ /** @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. */
7239
+ confirm?: boolean;
7205
7240
  };
7206
7241
  };
7207
7242
  };
@@ -7273,7 +7308,7 @@ export interface operations {
7273
7308
  };
7274
7309
  };
7275
7310
  };
7276
- designInWhiteboard: {
7311
+ getDeckReplyInWhiteboard: {
7277
7312
  parameters: {
7278
7313
  query?: never;
7279
7314
  header?: never;
@@ -7283,10 +7318,10 @@ export interface operations {
7283
7318
  requestBody?: {
7284
7319
  content: {
7285
7320
  "application/json": {
7286
- /** @description Ignored. Deprecated tool — use designDeck. */
7287
- documentId?: string;
7288
- /** @description Ignored. Deprecated tool — use designDeck. */
7289
- message?: string;
7321
+ /** @description The whiteboard that hosts the deck or illustration (it lives inside the board). REQUIRED. */
7322
+ documentId: string;
7323
+ /** @description The deck or illustration to poll, as returned by designDeckInWhiteboard or designIllustrationInWhiteboard. */
7324
+ deckId: string;
7290
7325
  };
7291
7326
  };
7292
7327
  };
@@ -7358,7 +7393,7 @@ export interface operations {
7358
7393
  };
7359
7394
  };
7360
7395
  };
7361
- editInWhiteboard: {
7396
+ exportFromWhiteboard: {
7362
7397
  parameters: {
7363
7398
  query?: never;
7364
7399
  header?: never;
@@ -7368,12 +7403,22 @@ export interface operations {
7368
7403
  requestBody?: {
7369
7404
  content: {
7370
7405
  "application/json": {
7371
- /** @description Ignored. Deprecated tool — use designDeck. */
7372
- documentId?: string;
7373
- /** @description Ignored. Deprecated tool — use designDeck. */
7374
- designId?: string;
7375
- /** @description Ignored. Deprecated tool — use designDeck. */
7376
- instruction?: string;
7406
+ /** @description The whiteboard that hosts the design. */
7407
+ documentId: string;
7408
+ /** @description The design to export (the deck id), as returned by designDeckInWhiteboard. */
7409
+ designId: string;
7410
+ /**
7411
+ * @description Which engine. 'deck' (default).
7412
+ * @enum {string}
7413
+ */
7414
+ kind?: "deck";
7415
+ /**
7416
+ * @description Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one base64 image per slide; 'html' = the design's self-contained HTML.
7417
+ * @enum {string}
7418
+ */
7419
+ format?: "pptx" | "pdf" | "png" | "html";
7420
+ /** @description Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary). */
7421
+ brandKitId?: string;
7377
7422
  };
7378
7423
  };
7379
7424
  };
@@ -7445,7 +7490,7 @@ export interface operations {
7445
7490
  };
7446
7491
  };
7447
7492
  };
7448
- exportFromWhiteboard: {
7493
+ startMeetingScribe: {
7449
7494
  parameters: {
7450
7495
  query?: never;
7451
7496
  header?: never;
@@ -7455,22 +7500,23 @@ export interface operations {
7455
7500
  requestBody?: {
7456
7501
  content: {
7457
7502
  "application/json": {
7458
- /** @description The whiteboard that hosts the design. */
7503
+ /** @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. */
7459
7504
  documentId: string;
7460
- /** @description The design to export (the deck id), as returned by designInWhiteboard. */
7461
- designId: string;
7462
- /**
7463
- * @description Which engine. 'deck' (default).
7464
- * @enum {string}
7465
- */
7466
- kind?: "deck";
7467
- /**
7468
- * @description Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one base64 image per slide; 'html' = the design's self-contained HTML.
7469
- * @enum {string}
7470
- */
7471
- format?: "pptx" | "pdf" | "png" | "html";
7472
- /** @description Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary). */
7473
- brandKitId?: string;
7505
+ /** @description The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected. */
7506
+ meetingUrl: string;
7507
+ /** @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. */
7508
+ agenda?: {
7509
+ /** @description The agenda item text. */
7510
+ label: string;
7511
+ /** @description Optional stable id; one is minted if omitted. */
7512
+ id?: string;
7513
+ }[];
7514
+ /** @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)') }. */
7515
+ settings?: {
7516
+ [key: string]: unknown;
7517
+ };
7518
+ /** @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. */
7519
+ confirm?: boolean;
7474
7520
  };
7475
7521
  };
7476
7522
  };
@@ -7542,7 +7588,7 @@ export interface operations {
7542
7588
  };
7543
7589
  };
7544
7590
  };
7545
- getDesignStatusInWhiteboard: {
7591
+ getMeetingScribeStatus: {
7546
7592
  parameters: {
7547
7593
  query?: never;
7548
7594
  header?: never;
@@ -7552,10 +7598,8 @@ export interface operations {
7552
7598
  requestBody?: {
7553
7599
  content: {
7554
7600
  "application/json": {
7555
- /** @description Ignored. Deprecated tool — use getDeckReply. */
7556
- documentId?: string;
7557
- /** @description Ignored. Deprecated tool — use getDeckReply. */
7558
- designId?: string;
7601
+ /** @description The meeting scribe session to poll, as returned by startMeetingScribe. */
7602
+ sessionId: string;
7559
7603
  };
7560
7604
  };
7561
7605
  };
@@ -7627,7 +7671,7 @@ export interface operations {
7627
7671
  };
7628
7672
  };
7629
7673
  };
7630
- generateInWhiteboard: {
7674
+ stopMeetingScribe: {
7631
7675
  parameters: {
7632
7676
  query?: never;
7633
7677
  header?: never;
@@ -7637,27 +7681,8 @@ export interface operations {
7637
7681
  requestBody?: {
7638
7682
  content: {
7639
7683
  "application/json": {
7640
- /** @description The whiteboard to generate the asset into (the asset is placed on this board). */
7641
- documentId: string;
7642
- /** @description Plain-language description of the asset to generate (e.g. 'a friendly robot assistant helping a small team'). */
7643
- prompt: string;
7644
- /**
7645
- * @description What to make. 'illustration' (default).
7646
- * @enum {string}
7647
- */
7648
- kind?: "illustration";
7649
- /** @description Optional output width in px (rounded to a multiple of 64, 512 to 2048). Default 1024. */
7650
- width?: number;
7651
- /** @description Optional output height in px (rounded to a multiple of 64, 512 to 2048). Default 1024. */
7652
- height?: number;
7653
- /** @description Optional extra style hint appended to the prompt (e.g. 'isometric', 'soft gradients, pastel'). */
7654
- style?: string;
7655
- /** @description Optional brand kit id to colour-condition the asset. Defaults to the organisation's effective brand. */
7656
- brandKitId?: string;
7657
- /** @description Optional x position on the board. Omit to auto-place. */
7658
- x?: number;
7659
- /** @description Optional y position on the board. Omit to auto-place. */
7660
- y?: number;
7684
+ /** @description The meeting scribe session to stop, as returned by startMeetingScribe. */
7685
+ sessionId: string;
7661
7686
  };
7662
7687
  };
7663
7688
  };
@@ -8379,6 +8404,8 @@ export interface operations {
8379
8404
  align?: "left" | "center" | "right";
8380
8405
  /** @description Optional original filename (for storage + type hinting). */
8381
8406
  fileName?: string;
8407
+ /** @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. */
8408
+ locked?: boolean;
8382
8409
  };
8383
8410
  };
8384
8411
  };
@@ -8468,19 +8495,26 @@ export interface operations {
8468
8495
  source: string;
8469
8496
  /** @description Optional caption shown beneath the diagram. */
8470
8497
  caption?: string;
8471
- /** @description Display width in px (aspect ratio preserved). Defaults to a capped natural size. */
8498
+ /** @description Display width in px (aspect ratio preserved). Auto-size caps at 480px; an explicit width is honoured up to 1200px. */
8472
8499
  width?: number;
8473
8500
  /** @description Display height in px (defaults from width + aspect). */
8474
8501
  height?: number;
8475
- /** @description Top-left x on the canvas. Omit to auto-place. */
8502
+ /** @description Top-left x on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given). */
8476
8503
  x?: number;
8477
- /** @description Top-left y on the canvas. Omit to auto-place. */
8504
+ /** @description Top-left y on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given). */
8478
8505
  y?: number;
8479
8506
  /**
8480
8507
  * @description Horizontal alignment relative to existing content (placed below it). Ignored if x/y given.
8481
8508
  * @enum {string}
8482
8509
  */
8483
8510
  align?: "left" | "center" | "right";
8511
+ /** @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. */
8512
+ updateElementId?: string;
8513
+ /**
8514
+ * @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.
8515
+ * @enum {string}
8516
+ */
8517
+ fit?: "contain";
8484
8518
  };
8485
8519
  };
8486
8520
  };
@@ -8854,11 +8888,6 @@ export interface operations {
8854
8888
  "application/json": {
8855
8889
  /** @description The whiteboard's documentId. */
8856
8890
  documentId: string;
8857
- /**
8858
- * @description png (default — a viewable raster) or svg (vector markup).
8859
- * @enum {string}
8860
- */
8861
- format?: "png" | "svg";
8862
8891
  /** @description Render only these element ids (plus their bound labels + group peers) instead of the whole board. */
8863
8892
  elementIds?: string[];
8864
8893
  /** @description Canvas background colour (default white), e.g. '#ffffff' or 'transparent'. */
@@ -9672,8 +9701,8 @@ export interface operations {
9672
9701
  content: {
9673
9702
  "application/json": {
9674
9703
  documentId: string;
9675
- /** @description Version timestamp from getDocument() for optimistic locking. */
9676
- documentVersionTimestamp: number;
9704
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
9705
+ documentVersionTimestamp?: number;
9677
9706
  /** @description Base64-encoded image data. Mutually exclusive with imageBinary/imageUrl. */
9678
9707
  imageBase64?: string;
9679
9708
  /** @description Raw binary as byte array. Mutually exclusive with imageBase64/imageUrl. */
@@ -9782,8 +9811,8 @@ export interface operations {
9782
9811
  "application/json": {
9783
9812
  /** @description Image ID from IMAGE_OMITTED markers. */
9784
9813
  imageId: string;
9785
- /** @description Version timestamp from getDocument() for optimistic locking. */
9786
- documentVersionTimestamp: number;
9814
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
9815
+ documentVersionTimestamp?: number;
9787
9816
  /** @description New alt text. */
9788
9817
  alt?: string;
9789
9818
  /** @description New image description. */