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