@stablebaseline/sdk 0.5.0 → 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 +373 -28
- package/dist/index.d.ts +373 -28
- package/openapi.json +403 -32
- package/package.json +2 -2
- package/src/types.generated.ts +373 -28
package/dist/index.d.cts
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;
|
|
@@ -763,6 +763,66 @@ interface paths {
|
|
|
763
763
|
patch?: never;
|
|
764
764
|
trace?: never;
|
|
765
765
|
};
|
|
766
|
+
"/tools/startMeetingScribe": {
|
|
767
|
+
parameters: {
|
|
768
|
+
query?: never;
|
|
769
|
+
header?: never;
|
|
770
|
+
path?: never;
|
|
771
|
+
cookie?: never;
|
|
772
|
+
};
|
|
773
|
+
get?: never;
|
|
774
|
+
put?: never;
|
|
775
|
+
/**
|
|
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
|
+
*/
|
|
779
|
+
post: operations["startMeetingScribe"];
|
|
780
|
+
delete?: never;
|
|
781
|
+
options?: never;
|
|
782
|
+
head?: never;
|
|
783
|
+
patch?: never;
|
|
784
|
+
trace?: never;
|
|
785
|
+
};
|
|
786
|
+
"/tools/getMeetingScribeStatus": {
|
|
787
|
+
parameters: {
|
|
788
|
+
query?: never;
|
|
789
|
+
header?: never;
|
|
790
|
+
path?: never;
|
|
791
|
+
cookie?: never;
|
|
792
|
+
};
|
|
793
|
+
get?: never;
|
|
794
|
+
put?: never;
|
|
795
|
+
/**
|
|
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
|
+
*/
|
|
799
|
+
post: operations["getMeetingScribeStatus"];
|
|
800
|
+
delete?: never;
|
|
801
|
+
options?: never;
|
|
802
|
+
head?: never;
|
|
803
|
+
patch?: never;
|
|
804
|
+
trace?: never;
|
|
805
|
+
};
|
|
806
|
+
"/tools/stopMeetingScribe": {
|
|
807
|
+
parameters: {
|
|
808
|
+
query?: never;
|
|
809
|
+
header?: never;
|
|
810
|
+
path?: never;
|
|
811
|
+
cookie?: never;
|
|
812
|
+
};
|
|
813
|
+
get?: never;
|
|
814
|
+
put?: never;
|
|
815
|
+
/**
|
|
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
|
+
*/
|
|
819
|
+
post: operations["stopMeetingScribe"];
|
|
820
|
+
delete?: never;
|
|
821
|
+
options?: never;
|
|
822
|
+
head?: never;
|
|
823
|
+
patch?: never;
|
|
824
|
+
trace?: never;
|
|
825
|
+
};
|
|
766
826
|
"/tools/createWhiteboard": {
|
|
767
827
|
parameters: {
|
|
768
828
|
query?: never;
|
|
@@ -914,7 +974,7 @@ interface paths {
|
|
|
914
974
|
put?: never;
|
|
915
975
|
/**
|
|
916
976
|
* insertWhiteboardDiagram
|
|
917
|
-
* @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.
|
|
918
978
|
*/
|
|
919
979
|
post: operations["insertWhiteboardDiagram"];
|
|
920
980
|
delete?: never;
|
|
@@ -1054,7 +1114,7 @@ interface paths {
|
|
|
1054
1114
|
put?: never;
|
|
1055
1115
|
/**
|
|
1056
1116
|
* getDiagramImage
|
|
1057
|
-
* @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.
|
|
1058
1118
|
*/
|
|
1059
1119
|
post: operations["getDiagramImage"];
|
|
1060
1120
|
delete?: never;
|
|
@@ -1194,7 +1254,7 @@ interface paths {
|
|
|
1194
1254
|
put?: never;
|
|
1195
1255
|
/**
|
|
1196
1256
|
* updateImageInDocument
|
|
1197
|
-
* @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.
|
|
1198
1258
|
*/
|
|
1199
1259
|
post: operations["updateImageInDocument"];
|
|
1200
1260
|
delete?: never;
|
|
@@ -5883,7 +5943,10 @@ interface operations {
|
|
|
5883
5943
|
projectId: string;
|
|
5884
5944
|
folderId?: string;
|
|
5885
5945
|
title?: string;
|
|
5886
|
-
|
|
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;
|
|
5887
5950
|
/** @description Sort position within the parent folder (or project root if no folderId). When omitted, the document is appended at the end. */
|
|
5888
5951
|
position?: number;
|
|
5889
5952
|
/** @description Version history summary. */
|
|
@@ -5976,7 +6039,7 @@ interface operations {
|
|
|
5976
6039
|
folderId?: string;
|
|
5977
6040
|
/** @description Sort position within the parent folder. Use to reposition a single document. For batch sibling reorder, use reorderDocuments. */
|
|
5978
6041
|
position?: number;
|
|
5979
|
-
/** @description
|
|
6042
|
+
/** @description Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.) */
|
|
5980
6043
|
versionTimestamp?: number;
|
|
5981
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. */
|
|
5982
6045
|
dryRun?: boolean;
|
|
@@ -6088,6 +6151,8 @@ interface operations {
|
|
|
6088
6151
|
replace: string;
|
|
6089
6152
|
/** @description Case-sensitive matching. Default: true. */
|
|
6090
6153
|
caseSensitive?: boolean;
|
|
6154
|
+
/** @description Optional optimistic-lock token from getDocument() or a previous write; validated when provided. (Alias accepted: documentVersionTimestamp.) */
|
|
6155
|
+
versionTimestamp?: number;
|
|
6091
6156
|
/** @description Version history summary. */
|
|
6092
6157
|
changeSummary?: string;
|
|
6093
6158
|
};
|
|
@@ -6257,8 +6322,8 @@ interface operations {
|
|
|
6257
6322
|
content: {
|
|
6258
6323
|
"application/json": {
|
|
6259
6324
|
documentId: string;
|
|
6260
|
-
/** @description
|
|
6261
|
-
documentVersionTimestamp
|
|
6325
|
+
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
6326
|
+
documentVersionTimestamp?: number;
|
|
6262
6327
|
/** @description Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types. */
|
|
6263
6328
|
type: string;
|
|
6264
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. */
|
|
@@ -6266,16 +6331,16 @@ interface operations {
|
|
|
6266
6331
|
/** @description Short description of what the diagram shows (1-2 sentences). */
|
|
6267
6332
|
prompt: string;
|
|
6268
6333
|
/** @description Extended description of the diagram (2-4 sentences). */
|
|
6269
|
-
nlDescription
|
|
6334
|
+
nlDescription?: string;
|
|
6270
6335
|
/**
|
|
6271
6336
|
* @description Alignment.
|
|
6272
6337
|
* @enum {string}
|
|
6273
6338
|
*/
|
|
6274
|
-
align
|
|
6339
|
+
align?: "left" | "center" | "right";
|
|
6275
6340
|
/** @description Caption below the diagram. */
|
|
6276
|
-
caption
|
|
6341
|
+
caption?: string;
|
|
6277
6342
|
/** @description Insert after this line number (1-based). */
|
|
6278
|
-
afterLine
|
|
6343
|
+
afterLine?: number;
|
|
6279
6344
|
/** @description BPMN only. Color plan: { byElementId: { ElementId: SwatchName } }. */
|
|
6280
6345
|
colorPlan?: {
|
|
6281
6346
|
/** @description Map of element IDs to color swatch names. */
|
|
@@ -6380,7 +6445,7 @@ interface operations {
|
|
|
6380
6445
|
"application/json": {
|
|
6381
6446
|
/** @description Diagram ID from DIAGRAM_OMITTED markers. */
|
|
6382
6447
|
diagramId: string;
|
|
6383
|
-
/** @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>`). */
|
|
6384
6449
|
diagramCode?: string;
|
|
6385
6450
|
/** @description New short description (metadata only — does NOT change the rendered diagram). */
|
|
6386
6451
|
prompt?: string;
|
|
@@ -6402,7 +6467,7 @@ interface operations {
|
|
|
6402
6467
|
};
|
|
6403
6468
|
/** @description Document-level optimistic lock: versionTimestamp from getDocument(). Locks the whole document. Provide this OR diagramVersionTimestamp (at least one is required). */
|
|
6404
6469
|
documentVersionTimestamp?: number;
|
|
6405
|
-
/** @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. */
|
|
6406
6471
|
diagramVersionTimestamp?: number;
|
|
6407
6472
|
};
|
|
6408
6473
|
};
|
|
@@ -6487,6 +6552,8 @@ interface operations {
|
|
|
6487
6552
|
"application/json": {
|
|
6488
6553
|
/** @description Diagram ID from DIAGRAM_OMITTED markers. */
|
|
6489
6554
|
diagramId: string;
|
|
6555
|
+
/** @description Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.) */
|
|
6556
|
+
versionTimestamp?: number;
|
|
6490
6557
|
};
|
|
6491
6558
|
};
|
|
6492
6559
|
};
|
|
@@ -6747,6 +6814,13 @@ interface operations {
|
|
|
6747
6814
|
designProfile?: "standard" | "branded-executive" | "illustrated" | "image" | "agentic" | "agentic-deck";
|
|
6748
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. */
|
|
6749
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
|
+
};
|
|
6750
6824
|
};
|
|
6751
6825
|
};
|
|
6752
6826
|
};
|
|
@@ -7415,6 +7489,270 @@ interface operations {
|
|
|
7415
7489
|
};
|
|
7416
7490
|
};
|
|
7417
7491
|
};
|
|
7492
|
+
startMeetingScribe: {
|
|
7493
|
+
parameters: {
|
|
7494
|
+
query?: never;
|
|
7495
|
+
header?: never;
|
|
7496
|
+
path?: never;
|
|
7497
|
+
cookie?: never;
|
|
7498
|
+
};
|
|
7499
|
+
requestBody?: {
|
|
7500
|
+
content: {
|
|
7501
|
+
"application/json": {
|
|
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. */
|
|
7503
|
+
documentId: string;
|
|
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;
|
|
7519
|
+
};
|
|
7520
|
+
};
|
|
7521
|
+
};
|
|
7522
|
+
responses: {
|
|
7523
|
+
/** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
|
|
7524
|
+
200: {
|
|
7525
|
+
headers: {
|
|
7526
|
+
[name: string]: unknown;
|
|
7527
|
+
};
|
|
7528
|
+
content: {
|
|
7529
|
+
"application/json": {
|
|
7530
|
+
[key: string]: unknown;
|
|
7531
|
+
};
|
|
7532
|
+
};
|
|
7533
|
+
};
|
|
7534
|
+
/** @description Validation error. */
|
|
7535
|
+
400: {
|
|
7536
|
+
headers: {
|
|
7537
|
+
[name: string]: unknown;
|
|
7538
|
+
};
|
|
7539
|
+
content: {
|
|
7540
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7541
|
+
};
|
|
7542
|
+
};
|
|
7543
|
+
/** @description Missing or invalid credentials. */
|
|
7544
|
+
401: {
|
|
7545
|
+
headers: {
|
|
7546
|
+
[name: string]: unknown;
|
|
7547
|
+
};
|
|
7548
|
+
content: {
|
|
7549
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7550
|
+
};
|
|
7551
|
+
};
|
|
7552
|
+
/** @description Authenticated but lacking the required permission or feature flag. */
|
|
7553
|
+
403: {
|
|
7554
|
+
headers: {
|
|
7555
|
+
[name: string]: unknown;
|
|
7556
|
+
};
|
|
7557
|
+
content: {
|
|
7558
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7559
|
+
};
|
|
7560
|
+
};
|
|
7561
|
+
/** @description Resource not found. */
|
|
7562
|
+
404: {
|
|
7563
|
+
headers: {
|
|
7564
|
+
[name: string]: unknown;
|
|
7565
|
+
};
|
|
7566
|
+
content: {
|
|
7567
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7568
|
+
};
|
|
7569
|
+
};
|
|
7570
|
+
/** @description Body did not match the tool's input schema. */
|
|
7571
|
+
422: {
|
|
7572
|
+
headers: {
|
|
7573
|
+
[name: string]: unknown;
|
|
7574
|
+
};
|
|
7575
|
+
content: {
|
|
7576
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7577
|
+
};
|
|
7578
|
+
};
|
|
7579
|
+
/** @description Server error. */
|
|
7580
|
+
500: {
|
|
7581
|
+
headers: {
|
|
7582
|
+
[name: string]: unknown;
|
|
7583
|
+
};
|
|
7584
|
+
content: {
|
|
7585
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7586
|
+
};
|
|
7587
|
+
};
|
|
7588
|
+
};
|
|
7589
|
+
};
|
|
7590
|
+
getMeetingScribeStatus: {
|
|
7591
|
+
parameters: {
|
|
7592
|
+
query?: never;
|
|
7593
|
+
header?: never;
|
|
7594
|
+
path?: never;
|
|
7595
|
+
cookie?: never;
|
|
7596
|
+
};
|
|
7597
|
+
requestBody?: {
|
|
7598
|
+
content: {
|
|
7599
|
+
"application/json": {
|
|
7600
|
+
/** @description The meeting scribe session to poll, as returned by startMeetingScribe. */
|
|
7601
|
+
sessionId: string;
|
|
7602
|
+
};
|
|
7603
|
+
};
|
|
7604
|
+
};
|
|
7605
|
+
responses: {
|
|
7606
|
+
/** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
|
|
7607
|
+
200: {
|
|
7608
|
+
headers: {
|
|
7609
|
+
[name: string]: unknown;
|
|
7610
|
+
};
|
|
7611
|
+
content: {
|
|
7612
|
+
"application/json": {
|
|
7613
|
+
[key: string]: unknown;
|
|
7614
|
+
};
|
|
7615
|
+
};
|
|
7616
|
+
};
|
|
7617
|
+
/** @description Validation error. */
|
|
7618
|
+
400: {
|
|
7619
|
+
headers: {
|
|
7620
|
+
[name: string]: unknown;
|
|
7621
|
+
};
|
|
7622
|
+
content: {
|
|
7623
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7624
|
+
};
|
|
7625
|
+
};
|
|
7626
|
+
/** @description Missing or invalid credentials. */
|
|
7627
|
+
401: {
|
|
7628
|
+
headers: {
|
|
7629
|
+
[name: string]: unknown;
|
|
7630
|
+
};
|
|
7631
|
+
content: {
|
|
7632
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7633
|
+
};
|
|
7634
|
+
};
|
|
7635
|
+
/** @description Authenticated but lacking the required permission or feature flag. */
|
|
7636
|
+
403: {
|
|
7637
|
+
headers: {
|
|
7638
|
+
[name: string]: unknown;
|
|
7639
|
+
};
|
|
7640
|
+
content: {
|
|
7641
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7642
|
+
};
|
|
7643
|
+
};
|
|
7644
|
+
/** @description Resource not found. */
|
|
7645
|
+
404: {
|
|
7646
|
+
headers: {
|
|
7647
|
+
[name: string]: unknown;
|
|
7648
|
+
};
|
|
7649
|
+
content: {
|
|
7650
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7651
|
+
};
|
|
7652
|
+
};
|
|
7653
|
+
/** @description Body did not match the tool's input schema. */
|
|
7654
|
+
422: {
|
|
7655
|
+
headers: {
|
|
7656
|
+
[name: string]: unknown;
|
|
7657
|
+
};
|
|
7658
|
+
content: {
|
|
7659
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7660
|
+
};
|
|
7661
|
+
};
|
|
7662
|
+
/** @description Server error. */
|
|
7663
|
+
500: {
|
|
7664
|
+
headers: {
|
|
7665
|
+
[name: string]: unknown;
|
|
7666
|
+
};
|
|
7667
|
+
content: {
|
|
7668
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7669
|
+
};
|
|
7670
|
+
};
|
|
7671
|
+
};
|
|
7672
|
+
};
|
|
7673
|
+
stopMeetingScribe: {
|
|
7674
|
+
parameters: {
|
|
7675
|
+
query?: never;
|
|
7676
|
+
header?: never;
|
|
7677
|
+
path?: never;
|
|
7678
|
+
cookie?: never;
|
|
7679
|
+
};
|
|
7680
|
+
requestBody?: {
|
|
7681
|
+
content: {
|
|
7682
|
+
"application/json": {
|
|
7683
|
+
/** @description The meeting scribe session to stop, as returned by startMeetingScribe. */
|
|
7684
|
+
sessionId: string;
|
|
7685
|
+
};
|
|
7686
|
+
};
|
|
7687
|
+
};
|
|
7688
|
+
responses: {
|
|
7689
|
+
/** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
|
|
7690
|
+
200: {
|
|
7691
|
+
headers: {
|
|
7692
|
+
[name: string]: unknown;
|
|
7693
|
+
};
|
|
7694
|
+
content: {
|
|
7695
|
+
"application/json": {
|
|
7696
|
+
[key: string]: unknown;
|
|
7697
|
+
};
|
|
7698
|
+
};
|
|
7699
|
+
};
|
|
7700
|
+
/** @description Validation error. */
|
|
7701
|
+
400: {
|
|
7702
|
+
headers: {
|
|
7703
|
+
[name: string]: unknown;
|
|
7704
|
+
};
|
|
7705
|
+
content: {
|
|
7706
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7707
|
+
};
|
|
7708
|
+
};
|
|
7709
|
+
/** @description Missing or invalid credentials. */
|
|
7710
|
+
401: {
|
|
7711
|
+
headers: {
|
|
7712
|
+
[name: string]: unknown;
|
|
7713
|
+
};
|
|
7714
|
+
content: {
|
|
7715
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7716
|
+
};
|
|
7717
|
+
};
|
|
7718
|
+
/** @description Authenticated but lacking the required permission or feature flag. */
|
|
7719
|
+
403: {
|
|
7720
|
+
headers: {
|
|
7721
|
+
[name: string]: unknown;
|
|
7722
|
+
};
|
|
7723
|
+
content: {
|
|
7724
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7725
|
+
};
|
|
7726
|
+
};
|
|
7727
|
+
/** @description Resource not found. */
|
|
7728
|
+
404: {
|
|
7729
|
+
headers: {
|
|
7730
|
+
[name: string]: unknown;
|
|
7731
|
+
};
|
|
7732
|
+
content: {
|
|
7733
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7734
|
+
};
|
|
7735
|
+
};
|
|
7736
|
+
/** @description Body did not match the tool's input schema. */
|
|
7737
|
+
422: {
|
|
7738
|
+
headers: {
|
|
7739
|
+
[name: string]: unknown;
|
|
7740
|
+
};
|
|
7741
|
+
content: {
|
|
7742
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7743
|
+
};
|
|
7744
|
+
};
|
|
7745
|
+
/** @description Server error. */
|
|
7746
|
+
500: {
|
|
7747
|
+
headers: {
|
|
7748
|
+
[name: string]: unknown;
|
|
7749
|
+
};
|
|
7750
|
+
content: {
|
|
7751
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7752
|
+
};
|
|
7753
|
+
};
|
|
7754
|
+
};
|
|
7755
|
+
};
|
|
7418
7756
|
createWhiteboard: {
|
|
7419
7757
|
parameters: {
|
|
7420
7758
|
query?: never;
|
|
@@ -8156,19 +8494,26 @@ interface operations {
|
|
|
8156
8494
|
source: string;
|
|
8157
8495
|
/** @description Optional caption shown beneath the diagram. */
|
|
8158
8496
|
caption?: string;
|
|
8159
|
-
/** @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. */
|
|
8160
8498
|
width?: number;
|
|
8161
8499
|
/** @description Display height in px (defaults from width + aspect). */
|
|
8162
8500
|
height?: number;
|
|
8163
|
-
/** @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). */
|
|
8164
8502
|
x?: number;
|
|
8165
|
-
/** @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). */
|
|
8166
8504
|
y?: number;
|
|
8167
8505
|
/**
|
|
8168
8506
|
* @description Horizontal alignment relative to existing content (placed below it). Ignored if x/y given.
|
|
8169
8507
|
* @enum {string}
|
|
8170
8508
|
*/
|
|
8171
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";
|
|
8172
8517
|
};
|
|
8173
8518
|
};
|
|
8174
8519
|
};
|
|
@@ -9355,8 +9700,8 @@ interface operations {
|
|
|
9355
9700
|
content: {
|
|
9356
9701
|
"application/json": {
|
|
9357
9702
|
documentId: string;
|
|
9358
|
-
/** @description
|
|
9359
|
-
documentVersionTimestamp
|
|
9703
|
+
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
9704
|
+
documentVersionTimestamp?: number;
|
|
9360
9705
|
/** @description Base64-encoded image data. Mutually exclusive with imageBinary/imageUrl. */
|
|
9361
9706
|
imageBase64?: string;
|
|
9362
9707
|
/** @description Raw binary as byte array. Mutually exclusive with imageBase64/imageUrl. */
|
|
@@ -9465,8 +9810,8 @@ interface operations {
|
|
|
9465
9810
|
"application/json": {
|
|
9466
9811
|
/** @description Image ID from IMAGE_OMITTED markers. */
|
|
9467
9812
|
imageId: string;
|
|
9468
|
-
/** @description
|
|
9469
|
-
documentVersionTimestamp
|
|
9813
|
+
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
9814
|
+
documentVersionTimestamp?: number;
|
|
9470
9815
|
/** @description New alt text. */
|
|
9471
9816
|
alt?: string;
|
|
9472
9817
|
/** @description New image description. */
|