@stablebaseline/sdk 0.5.0 → 0.5.2

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.ts CHANGED
@@ -34,7 +34,7 @@ interface paths {
34
34
  put?: never;
35
35
  /**
36
36
  * listDiagramTypes
37
- * @description List supported diagram types. Use the returned `type` field when calling insertDiagramInDocument.
37
+ * @description List supported diagram types. Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema'. Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.
38
38
  */
39
39
  post: operations["listDiagramTypes"];
40
40
  delete?: never;
@@ -234,7 +234,7 @@ interface paths {
234
234
  put?: never;
235
235
  /**
236
236
  * listWorkspaces
237
- * @description List workspaces you have access to. Supports query filtering by name/slug.
237
+ * @description List workspaces you have access to. Scope to one organisation with organisationId (a structural filter — use it rather than `query`, which only searches names/slugs). Supports query filtering by name/slug.
238
238
  */
239
239
  post: operations["listWorkspaces"];
240
240
  delete?: never;
@@ -374,7 +374,7 @@ interface paths {
374
374
  put?: never;
375
375
  /**
376
376
  * listDocuments
377
- * @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering.
377
+ * @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering. SCOPE HONESTY — read this before concluding something is absent: only documents that actually matched are returned (a document is never listed with matchCount 0 just because it was in scope), and the `grep` block reports `scannedDocuments` against `totalDocumentsInScope`. When `truncated` is true the search covered only part of the scope, so an absence is NOT proof; repeat with `scanOffset` set to the returned `nextScanOffset` until that field is gone, and union the results. A document too large to read is returned with `contentSearchSkipped: true` and NO matchCount, because its body was never searched.
378
378
  */
379
379
  post: operations["listDocuments"];
380
380
  delete?: never;
@@ -414,7 +414,7 @@ interface paths {
414
414
  put?: never;
415
415
  /**
416
416
  * getFolderHierarchy
417
- * @description Get the folder and document tree starting from a specific folder. Alias for getProjectHierarchy with folderId.
417
+ * @description Get the folder and document tree. Pass folderId for the subtree under one folder, or projectId for the project's ENTIRE folder tree from the root (no need to reassemble listFolders' flat list by parentId). Alias for getProjectHierarchy.
418
418
  */
419
419
  post: operations["getFolderHierarchy"];
420
420
  delete?: never;
@@ -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. Returns numbered lines for use with editDocument. Diagrams/images appear as OMITTED markers with metadata (type, diagramId, nlDescription) — use getDiagramInDocument(diagramId) for full DSL code, or dedicated diagram/image tools to manage them. Pass includeDiagramDsl:true to inline each diagram's DSL and versionTimestamp directly into its DIAGRAM_OMITTED marker (saves a getDiagramInDocument call when you intend to read or edit diagrams).
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. Call getCdmdLanguageGuide first if unfamiliar with syntax. Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Supports @-mentioning people: embed `<!-- REFERENCE: {"type":"user","id":"<user_uuid>","label":"Name"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.
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). A leading `---` YAML frontmatter block is stored and preserved: title/exported_at/generator are managed by the platform, and any other key you set (doc_type, authority_state, owner, conforms_to, …) round-trips untouched through reads and later edits. 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 (line patches with optimistic locking). Case-sensitive by default. Diagrams/images are automatically protected — only document text is affected. Note: when the `replace` value contains a `<!-- REFERENCE: {...} -->` marker (e.g. inserting a user mention), it round-trips losslessly through the editor and triggers notifications if it adds a new user mention.
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. Always set prompt + nlDescription to describe what the diagram shows (they are its saved description) and keep them accurate. After inserting, VERIFY the render — set returnImage:true (or call getDiagramImage) to actually SEE it — and if it is wrong or ugly, correct it with updateDiagramInDocument (provide the full updated diagramCode).
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. Provide a version lock: EITHER documentVersionTimestamp (from getDocument — locks the whole document) OR diagramVersionTimestamp (from getDiagramInDocument, or getDocument with includeDiagramDsl:true — locks just THIS diagram, so two agents can edit two different diagrams in the same document concurrently without a conflict). At least one is required; diagramVersionTimestamp is preferred for concurrency. IMPORTANT: To change what the diagram visually shows, you MUST provide diagramCode with the full updated DSL source. The prompt and nlDescription fields are metadata only and do NOT change the rendered diagram. After updating, re-render with getDiagramImage to confirm it now looks right (iterate if not), and keep prompt/nlDescription in step with what the diagram now shows.
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 from a document.
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;
@@ -694,7 +694,7 @@ interface paths {
694
694
  put?: never;
695
695
  /**
696
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.
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. GENERATED IMAGES are extra and OFF by default: decks are type-only unless the user asks for visuals, in which case set imageCount (5 credits each, ceiling scales with slide count and plan tier, max 10) and the exact total is quoted before anything is charged — exactly that many images are produced, and the image surcharge auto-refunds if the build cannot deliver them. ADVANCED DECK BUILDING (optional, OFF by default): set advancedDeckBuilding:true to build the deck over several rounds of redraft and review by a panel of design, brand, accessibility and copy reviewers instead of one composer pass. It usually raises design quality, but it is not a guarantee. It is much slower and it costs more: a standard build takes roughly 2 to 8 minutes, advanced deck building takes roughly 15 to 20 minutes, and it adds 15 credits per depth level on top of the turn fee (advancedDeckBuildingDepth is 1 to 3, default 3, so +45 credits, making a 50-credit build cost 95). Only turn it on when the user asks for the highest quality and accepts the wait and the cost. 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, slideCount + slideCountClamped (the target the conversation now carries, and whether it was reduced to the maximum), advancedDeckBuilding (whether advanced deck building is on for this conversation), advancedDeckBuildingStatus, and assistantMessage. Export the finished deck with exportFromWhiteboard.
698
698
  */
699
699
  post: operations["designDeckInWhiteboard"];
700
700
  delete?: never;
@@ -734,7 +734,7 @@ interface paths {
734
734
  put?: never;
735
735
  /**
736
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.
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). While a turn is running it additionally returns live build state: stage, percent, feed (the agent's real per-step lines), slideTarget (the count it is building to), slides (the finished slides so far, each with a fetchable image url), partialHtml (the deck so far), and, when advanced deck building is on, advancedDeckBuildingProgress (the round-by-round reviewer scores; also emitted as the deprecated `jury` field for one release). Every one of those is optional and absent when there is nothing to report. A standard turn usually takes about 2 to 8 minutes, so poll every 15 to 30 seconds until it is 'ready' or awaitingUser is true; a turn running with advanced deck building takes roughly 15 to 20 minutes, so keep polling for that long before treating it as stuck. 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
739
  post: operations["getDeckReplyInWhiteboard"];
740
740
  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, …) into a whiteboard as an editable SB diagram element. Provide documentId, diagramType (call listDiagramTypes / getDiagramTypeGuide), and source (the DSL). The diagram is rendered to an image stored like a pasted image, and its editable source is kept in a sidecar so it stays a live, re-openable diagram on the board (double-click on the canvas opens the BPMN / code / AI editor). Options: caption (label beneath it), width/height to size it, and x/y or align ('left'|'center'|'right') to place it (defaults to the right of existing content). After inserting, call getWhiteboardImage to see it and verify it rendered correctly (fix the source and re-insert if it is wrong). For a plain picture (not a diagram) use insertWhiteboardImage; to generate a diagram image WITHOUT inserting use renderDiagram.
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;
@@ -1094,7 +1154,7 @@ interface paths {
1094
1154
  put?: never;
1095
1155
  /**
1096
1156
  * reorderDocuments
1097
- * @description Batch-reorder documents within a folder (or project root) by setting sibling positions. Pass [{documentId, position}, ...] where position is a non-negative integer; usually you renumber siblings sequentially as 0, 1, 2…. Position-only update — does not bump version or create a snapshot. To MOVE a document to a different folder, use editDocument({folderId, position}) instead.
1157
+ * @description MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position, folderId?}, ...]: `position` is a non-negative integer (usually renumber siblings sequentially as 0, 1, 2…), and the optional per-item `folderId` MOVES that document into the given folder (use null to move it to the project root; omit it to leave the document where it is). Use this to reorganise a project — file loose documents into subfolders, restructure a folder tree, or reorder siblings — in one call. Filing is metadata only: it does NOT bump the document version and does NOT create a version-history snapshot, so tidying folders never shows up as a content revision. A bad folderId fails the whole call rather than half-applying it. For a single document you can also use editDocument({documentId, folderId, position}), which behaves identically (and likewise creates no version when only the filing changes).
1098
1158
  */
1099
1159
  post: operations["reorderDocuments"];
1100
1160
  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 documentVersionTimestamp from getDocument for optimistic locking.
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;
@@ -1374,7 +1434,7 @@ interface paths {
1374
1434
  put?: never;
1375
1435
  /**
1376
1436
  * createImprovement
1377
- * @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID.
1437
+ * @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID. Accepts every field updateImprovement accepts, so an item can be created complete in one call rather than create-then-update.
1378
1438
  */
1379
1439
  post: operations["createImprovement"];
1380
1440
  delete?: never;
@@ -1394,7 +1454,7 @@ interface paths {
1394
1454
  put?: never;
1395
1455
  /**
1396
1456
  * updateImprovement
1397
- * @description Update an improvement (or a task — tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution) and `acceptance_criteria` (objects with per-row updated_by/at attribution). Requires versionTimestamp from getImprovement for optimistic locking. Status transitions: blocked needs blocked_comment, rejected needs rejection_comment, done needs completion_comment. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — a DB CHECK constraint enforces this). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch from a user owner to a team owner, send `owner_id=null, owner_team_id=<uuid>` in the SAME call (sending only one side leaves the stale value and triggers the XOR check). Use listAssignablePrincipals or listTeams to discover valid IDs.
1457
+ * @description Update an improvement (or a task — tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution) and `acceptance_criteria` (objects with per-row updated_by/at attribution). Requires versionTimestamp from getImprovement for optimistic locking. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked needs blocked_comment, rejected needs rejection_comment, done needs completion_comment); leaving one for an open status needs reopened_comment — including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — a DB CHECK constraint enforces this). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch from a user owner to a team owner, send `owner_id=null, owner_team_id=<uuid>` in the SAME call (sending only one side leaves the stale value and triggers the XOR check). Use listAssignablePrincipals or listTeams to discover valid IDs.
1398
1458
  */
1399
1459
  post: operations["updateImprovement"];
1400
1460
  delete?: never;
@@ -1918,7 +1978,7 @@ interface paths {
1918
1978
  put?: never;
1919
1979
  /**
1920
1980
  * createTask
1921
- * @description Create a task in a plan. Requires planId and title.
1981
+ * @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call — no create-then-update, and no window in which other actors read a half-written record.
1922
1982
  */
1923
1983
  post: operations["createTask"];
1924
1984
  delete?: never;
@@ -1978,7 +2038,7 @@ interface paths {
1978
2038
  put?: never;
1979
2039
  /**
1980
2040
  * updateTask
1981
- * @description Update a task. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement — every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, status transitions (blocked/rejected/done need their respective comments), dates, owner, percent_complete, etc. Requires versionTimestamp from getTask for optimistic locking. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here — array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — the DB enforces with a CHECK constraint). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.
2041
+ * @description Update a task. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement — every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, etc. Requires versionTimestamp from getTask for optimistic locking. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment — including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here — array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — the DB enforces with a CHECK constraint). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.
1982
2042
  */
1983
2043
  post: operations["updateTask"];
1984
2044
  delete?: never;
@@ -2098,7 +2158,7 @@ interface paths {
2098
2158
  put?: never;
2099
2159
  /**
2100
2160
  * deleteTaskDependency
2101
- * @description Remove a task-dependency edge. Neither item's dates are changed.
2161
+ * @description Remove a task-dependency edge. Neither item's dates are changed. Needs the same 'write' plan permission as createTaskDependency, so an actor that can draw an edge can also undo it — the edge is fully recreatable from (predecessor, successor, type, lag).
2102
2162
  */
2103
2163
  post: operations["deleteTaskDependency"];
2104
2164
  delete?: never;
@@ -4009,6 +4069,7 @@ interface operations {
4009
4069
  requestBody?: {
4010
4070
  content: {
4011
4071
  "application/json": {
4072
+ /** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing'. Semantic-backed: matches descriptions, not just names. */
4012
4073
  query?: string;
4013
4074
  enabledOnly?: boolean;
4014
4075
  limit?: number;
@@ -4519,6 +4580,8 @@ interface operations {
4519
4580
  /** @description Workspace UUID. Optional but recommended — when present, the result includes ALL org members; when omitted, only direct project grants + team-expanded users are returned. */
4520
4581
  workspaceId?: string;
4521
4582
  /** @description Optional ILIKE search filter — matched against display_name + email (users) and team name (teams). */
4583
+ query?: string;
4584
+ /** @description Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses. */
4522
4585
  q?: string;
4523
4586
  /**
4524
4587
  * @description Filter to one principal kind. Default 'all' returns users first then teams.
@@ -4615,6 +4678,8 @@ interface operations {
4615
4678
  /** @description Workspace UUID. The parent organization is resolved from v_workspaces. */
4616
4679
  workspaceId?: string;
4617
4680
  /** @description Optional ILIKE search on team name/slug. */
4681
+ query?: string;
4682
+ /** @description Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses. */
4618
4683
  q?: string;
4619
4684
  /** @description When true, each team gets a `members` array (user_id, role, joined_at). Capped at 500 total members across the page. Default false. */
4620
4685
  includeMembers?: boolean;
@@ -4874,6 +4939,10 @@ interface operations {
4874
4939
  requestBody?: {
4875
4940
  content: {
4876
4941
  "application/json": {
4942
+ /** @description Return only workspaces in this organisation. Use listOrganisations to find the id. (organizationId is accepted as a spelling alias.) */
4943
+ organisationId?: string;
4944
+ /** @description Spelling alias for organisationId. */
4945
+ organizationId?: string;
4877
4946
  query?: string;
4878
4947
  limit?: number;
4879
4948
  offset?: number;
@@ -5505,7 +5574,10 @@ interface operations {
5505
5574
  /** @description Cap on matching lines returned per document. 1-20, default 5. */
5506
5575
  maxMatchesPerDocument?: number;
5507
5576
  limit?: number;
5577
+ /** @description Pagination offset over the MATCHES. When searching, use scanOffset (not this) to reach documents the scan has not covered. */
5508
5578
  offset?: number;
5579
+ /** @description Search-only. Where to start the document scan within the scope. One call examines a bounded window; when the response reports truncated:true it also returns nextScanOffset — repeat with scanOffset set to that value until nextScanOffset is absent, and union the results, to search a scope larger than one window exhaustively. */
5580
+ scanOffset?: number;
5509
5581
  /** @description ISO 8601 date filter (from). */
5510
5582
  fromDate?: string;
5511
5583
  /** @description ISO 8601 date filter (to). */
@@ -5692,8 +5764,10 @@ interface operations {
5692
5764
  requestBody?: {
5693
5765
  content: {
5694
5766
  "application/json": {
5695
- /** @description The folder ID to start from. */
5696
- folderId: string;
5767
+ /** @description Return the whole project's folder tree from the root. Provide this or folderId. */
5768
+ projectId?: string;
5769
+ /** @description The folder ID to start from. Omit and pass projectId to get the project root hierarchy. */
5770
+ folderId?: string;
5697
5771
  /** @description Max nesting depth. Default: 10, max: 20. */
5698
5772
  maxDepth?: number;
5699
5773
  /** @description Include documents. Default: true. */
@@ -5787,7 +5861,9 @@ interface operations {
5787
5861
  requestBody?: {
5788
5862
  content: {
5789
5863
  "application/json": {
5790
- /** @description The document ID to read. */
5864
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
5865
+ projectId?: string;
5866
+ /** @description The document ID to read. Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
5791
5867
  documentId: string;
5792
5868
  /** @description Lines to skip from start. Default: 0. */
5793
5869
  offset?: number;
@@ -5883,7 +5959,10 @@ interface operations {
5883
5959
  projectId: string;
5884
5960
  folderId?: string;
5885
5961
  title?: string;
5886
- cdmd: string;
5962
+ /** @description Document body in CDMD markdown. Alias: content. */
5963
+ cdmd?: string;
5964
+ /** @description Alias for cdmd — provide one of the two. */
5965
+ content?: string;
5887
5966
  /** @description Sort position within the parent folder (or project root if no folderId). When omitted, the document is appended at the end. */
5888
5967
  position?: number;
5889
5968
  /** @description Version history summary. */
@@ -5969,15 +6048,19 @@ interface operations {
5969
6048
  requestBody?: {
5970
6049
  content: {
5971
6050
  "application/json": {
6051
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
6052
+ projectId?: string;
5972
6053
  documentId: string;
5973
6054
  /** @description New title. */
5974
6055
  title?: string;
5975
- /** @description Move to this folder. */
5976
- folderId?: string;
5977
- /** @description Sort position within the parent folder. Use to reposition a single document. For batch sibling reorder, use reorderDocuments. */
6056
+ /** @description MOVE the document into this folder (null moves it to the project root). Send it with patches:[] to file the document without touching its content — a folder-only move updates folder_id, creates NO version-history entry, and does not bump the document version. To move many documents at once use reorderDocuments, which takes folderId per item. */
6057
+ folderId?: string | null;
6058
+ /** @description Sort position within the parent folder. Use to reposition a single document; like folderId, a position-only change creates no version. For batch sibling reorder/move, use reorderDocuments. */
5978
6059
  position?: number;
5979
- /** @description Version timestamp from getDocument() for optimistic locking. Required unless dryRun:true. */
6060
+ /** @description Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.) */
5980
6061
  versionTimestamp?: number;
6062
+ /** @description Legacy integer version guard, checked in addition to versionTimestamp. Prefer versionTimestamp — this exists for older clients and is optional. */
6063
+ expectedVersion?: number;
5981
6064
  /** @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
6065
  dryRun?: boolean;
5983
6066
  /** @description Version history summary. */
@@ -6081,6 +6164,8 @@ interface operations {
6081
6164
  requestBody?: {
6082
6165
  content: {
6083
6166
  "application/json": {
6167
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
6168
+ projectId?: string;
6084
6169
  documentId: string;
6085
6170
  /** @description Text to search for. */
6086
6171
  find: string;
@@ -6088,6 +6173,8 @@ interface operations {
6088
6173
  replace: string;
6089
6174
  /** @description Case-sensitive matching. Default: true. */
6090
6175
  caseSensitive?: boolean;
6176
+ /** @description Optional optimistic-lock token from getDocument() or a previous write; validated when provided. (Alias accepted: documentVersionTimestamp.) */
6177
+ versionTimestamp?: number;
6091
6178
  /** @description Version history summary. */
6092
6179
  changeSummary?: string;
6093
6180
  };
@@ -6256,9 +6343,11 @@ interface operations {
6256
6343
  requestBody?: {
6257
6344
  content: {
6258
6345
  "application/json": {
6346
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
6347
+ projectId?: string;
6259
6348
  documentId: string;
6260
- /** @description Version timestamp from getDocument() for optimistic locking. */
6261
- documentVersionTimestamp: number;
6349
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
6350
+ documentVersionTimestamp?: number;
6262
6351
  /** @description Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types. */
6263
6352
  type: string;
6264
6353
  /** @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 +6355,16 @@ interface operations {
6266
6355
  /** @description Short description of what the diagram shows (1-2 sentences). */
6267
6356
  prompt: string;
6268
6357
  /** @description Extended description of the diagram (2-4 sentences). */
6269
- nlDescription: string;
6358
+ nlDescription?: string;
6270
6359
  /**
6271
6360
  * @description Alignment.
6272
6361
  * @enum {string}
6273
6362
  */
6274
- align: "left" | "center" | "right";
6363
+ align?: "left" | "center" | "right";
6275
6364
  /** @description Caption below the diagram. */
6276
- caption: string;
6365
+ caption?: string;
6277
6366
  /** @description Insert after this line number (1-based). */
6278
- afterLine: number;
6367
+ afterLine?: number;
6279
6368
  /** @description BPMN only. Color plan: { byElementId: { ElementId: SwatchName } }. */
6280
6369
  colorPlan?: {
6281
6370
  /** @description Map of element IDs to color swatch names. */
@@ -6380,7 +6469,7 @@ interface operations {
6380
6469
  "application/json": {
6381
6470
  /** @description Diagram ID from DIAGRAM_OMITTED markers. */
6382
6471
  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. */
6472
+ /** @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
6473
  diagramCode?: string;
6385
6474
  /** @description New short description (metadata only — does NOT change the rendered diagram). */
6386
6475
  prompt?: string;
@@ -6402,7 +6491,7 @@ interface operations {
6402
6491
  };
6403
6492
  /** @description Document-level optimistic lock: versionTimestamp from getDocument(). Locks the whole document. Provide this OR diagramVersionTimestamp (at least one is required). */
6404
6493
  documentVersionTimestamp?: number;
6405
- /** @description Diagram-level optimistic lock: versionTimestamp of THIS diagram (from getDiagramInDocument, or getDocument with includeDiagramDsl:true). Pass this instead of documentVersionTimestamp to lock only this diagram, so concurrent edits to OTHER diagrams in the same document don't conflict. Preferred for multi-agent concurrency. The response returns the new diagram.diagramVersionTimestamp for chaining further edits. */
6494
+ /** @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
6495
  diagramVersionTimestamp?: number;
6407
6496
  };
6408
6497
  };
@@ -6487,6 +6576,8 @@ interface operations {
6487
6576
  "application/json": {
6488
6577
  /** @description Diagram ID from DIAGRAM_OMITTED markers. */
6489
6578
  diagramId: string;
6579
+ /** @description Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.) */
6580
+ versionTimestamp?: number;
6490
6581
  };
6491
6582
  };
6492
6583
  };
@@ -6569,6 +6660,8 @@ interface operations {
6569
6660
  content: {
6570
6661
  "application/json": {
6571
6662
  documentId: string;
6663
+ /** @description Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID. */
6664
+ projectId?: string;
6572
6665
  };
6573
6666
  };
6574
6667
  };
@@ -6747,6 +6840,13 @@ interface operations {
6747
6840
  designProfile?: "standard" | "branded-executive" | "illustrated" | "image" | "agentic" | "agentic-deck";
6748
6841
  /** @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
6842
  brandKitId?: string;
6843
+ /** @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. */
6844
+ sourceTranscript?: {
6845
+ /** @description The id of a Stable Baseline document holding the meeting transcript/notes to design from. */
6846
+ documentId?: string;
6847
+ /** @description The raw transcript text to design from (pasted). Provide this OR documentId, not both. */
6848
+ text?: string;
6849
+ };
6750
6850
  };
6751
6851
  };
6752
6852
  };
@@ -6850,6 +6950,8 @@ interface operations {
6850
6950
  tags?: string[];
6851
6951
  /** @description Optional URL of a reference image the component should match; the critic compares the render to it. */
6852
6952
  referenceImageUrl?: string;
6953
+ /** @description Optional brand kit id (from listBrandKits) to theme the component. If omitted, the organisation's effective brand is used. */
6954
+ brandKitId?: string;
6853
6955
  /** @description Redesign even if a component with this key already exists (default false = reuse). */
6854
6956
  force?: boolean;
6855
6957
  };
@@ -7026,7 +7128,7 @@ interface operations {
7026
7128
  "application/json": {
7027
7129
  /** @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. */
7028
7130
  documentId: string;
7029
- /** @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. */
7131
+ /** @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. If the user mentioned how many slides they want, ALSO pass slideCount with that number — never leave the count only in prose, and never outline more slides in this message than slideCount. */
7030
7132
  message: string;
7031
7133
  /** @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. */
7032
7134
  sessionId?: string;
@@ -7041,8 +7143,14 @@ interface operations {
7041
7143
  title?: string;
7042
7144
  /** @description Optional brand kit id (from listBrandKits) to theme the deck. If omitted, the organisation's effective brand is used. */
7043
7145
  brandKitId?: string;
7044
- /** @description Optional target number of slides for a build turn (the composer adjusts to fit the story). Typical 6 to 12. */
7146
+ /** @description The number of slides to build — a hard requirement: the deck is built with exactly this many slides. SET THIS whenever the user states or implies a count, EXACT OR APPROXIMATE: '12 slides' → 12, 'about 15' / '15 or so' → 15, 'no more than 10' → 10. Never expand the user's number: if they said 'about 15', pass 15 and shape the brief to fit 15 — outlining 19 sections in the message does not raise the count, it just fights this parameter. It is PERSISTED on the conversation, so send it ONCE (on the turn that states it) and every later build turn of the same conversation carries it automatically; send it again only to CHANGE the target. It is honoured on edit turns too ('cut it to 8 slides'). Anything above the 30-slide maximum is reduced to 30 and the reduction is stated back in the response. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12). */
7045
7147
  slideCount?: number;
7148
+ /** @description How many AI-GENERATED images this turn may produce. DEFAULT IS 0 — decks are type-only unless the user asks for visuals. SET THIS when the user wants imagery: 'a cover image' → 1, 'a few images' → 2, 'image-led / very visual' → omit nothing and pass a higher number. Each image costs 5 extra credits, quoted upfront in the confirmation (base fee + images), and EXACTLY this many are produced — never more, never fewer (the image surcharge is auto-refunded if the build cannot deliver them). The ceiling scales with the deck (about one image per three slides, so a 30-slide deck tops out at 10) and with the plan tier; anything above the ceiling is reduced and the reduction is stated back. If omitted, the count is derived conservatively from the user's wording (silence = 0). */
7149
+ imageCount?: number;
7150
+ /** @description Optional, OFF by default. Build the deck with ADVANCED DECK BUILDING: instead of one composer pass, the deck is redrafted and reviewed over several rounds by a panel of design, brand, accessibility and copy reviewers, each round scoring the deck and listing what must be fixed. It usually produces a higher-quality deck, but it is not a guarantee. TIME: a standard build takes roughly 2 to 8 minutes; advanced deck building takes roughly 15 to 20 minutes. COST: 15 extra credits per depth level on top of the turn fee, so the default depth of 3 adds 45 credits and makes a 50-credit build cost 95. This is the user's deliberate choice, so only switch it on when they have asked for the best possible deck and accepted the wait and the cost. Quote the turn FIRST (call without confirm) so the user sees the real total before approving. Set it once and it is remembered for the rest of the conversation; pass false to turn it off again. */
7151
+ advancedDeckBuilding?: boolean;
7152
+ /** @description Optional. How many redraft-and-review rounds advanced deck building may run: 1 to 3, default 3. Each round is a full redraft plus four reviews, adds roughly 5 minutes, and costs 15 credits (depth 1 = +15, depth 2 = +30, depth 3 = +45). Ignored unless advancedDeckBuilding is true. */
7153
+ advancedDeckBuildingDepth?: number;
7046
7154
  /** @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. */
7047
7155
  attachments?: {
7048
7156
  /** @description A public https URL to the image. */
@@ -7053,6 +7161,8 @@ interface operations {
7053
7161
  mediaType?: string;
7054
7162
  /** @description Optional human-readable name for the image. */
7055
7163
  name?: string;
7164
+ /** @description Optional attachment type hint, passed through to the design worker. */
7165
+ type?: string;
7056
7166
  }[];
7057
7167
  /** @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. */
7058
7168
  confirm?: boolean;
@@ -7159,6 +7269,8 @@ interface operations {
7159
7269
  mediaType?: string;
7160
7270
  /** @description Optional human-readable name for the image. */
7161
7271
  name?: string;
7272
+ /** @description Optional attachment type hint, passed through to the design worker. */
7273
+ type?: string;
7162
7274
  }[];
7163
7275
  /** @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. */
7164
7276
  confirm?: boolean;
@@ -7415,6 +7527,275 @@ interface operations {
7415
7527
  };
7416
7528
  };
7417
7529
  };
7530
+ startMeetingScribe: {
7531
+ parameters: {
7532
+ query?: never;
7533
+ header?: never;
7534
+ path?: never;
7535
+ cookie?: never;
7536
+ };
7537
+ requestBody?: {
7538
+ content: {
7539
+ "application/json": {
7540
+ /** @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. */
7541
+ documentId: string;
7542
+ /** @description The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected. */
7543
+ meetingUrl: string;
7544
+ /** @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. */
7545
+ agenda?: {
7546
+ /** @description The agenda item text. */
7547
+ label: string;
7548
+ /** @description Optional stable id; one is minted if omitted. */
7549
+ id?: string;
7550
+ /**
7551
+ * @description Optional starting status sticker. Default: pending.
7552
+ * @enum {string}
7553
+ */
7554
+ status?: "pending" | "active" | "done";
7555
+ }[];
7556
+ /** @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)') }. */
7557
+ settings?: {
7558
+ [key: string]: unknown;
7559
+ };
7560
+ /** @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. */
7561
+ confirm?: boolean;
7562
+ };
7563
+ };
7564
+ };
7565
+ responses: {
7566
+ /** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
7567
+ 200: {
7568
+ headers: {
7569
+ [name: string]: unknown;
7570
+ };
7571
+ content: {
7572
+ "application/json": {
7573
+ [key: string]: unknown;
7574
+ };
7575
+ };
7576
+ };
7577
+ /** @description Validation error. */
7578
+ 400: {
7579
+ headers: {
7580
+ [name: string]: unknown;
7581
+ };
7582
+ content: {
7583
+ "application/json": components["schemas"]["ErrorResponse"];
7584
+ };
7585
+ };
7586
+ /** @description Missing or invalid credentials. */
7587
+ 401: {
7588
+ headers: {
7589
+ [name: string]: unknown;
7590
+ };
7591
+ content: {
7592
+ "application/json": components["schemas"]["ErrorResponse"];
7593
+ };
7594
+ };
7595
+ /** @description Authenticated but lacking the required permission or feature flag. */
7596
+ 403: {
7597
+ headers: {
7598
+ [name: string]: unknown;
7599
+ };
7600
+ content: {
7601
+ "application/json": components["schemas"]["ErrorResponse"];
7602
+ };
7603
+ };
7604
+ /** @description Resource not found. */
7605
+ 404: {
7606
+ headers: {
7607
+ [name: string]: unknown;
7608
+ };
7609
+ content: {
7610
+ "application/json": components["schemas"]["ErrorResponse"];
7611
+ };
7612
+ };
7613
+ /** @description Body did not match the tool's input schema. */
7614
+ 422: {
7615
+ headers: {
7616
+ [name: string]: unknown;
7617
+ };
7618
+ content: {
7619
+ "application/json": components["schemas"]["ErrorResponse"];
7620
+ };
7621
+ };
7622
+ /** @description Server error. */
7623
+ 500: {
7624
+ headers: {
7625
+ [name: string]: unknown;
7626
+ };
7627
+ content: {
7628
+ "application/json": components["schemas"]["ErrorResponse"];
7629
+ };
7630
+ };
7631
+ };
7632
+ };
7633
+ getMeetingScribeStatus: {
7634
+ parameters: {
7635
+ query?: never;
7636
+ header?: never;
7637
+ path?: never;
7638
+ cookie?: never;
7639
+ };
7640
+ requestBody?: {
7641
+ content: {
7642
+ "application/json": {
7643
+ /** @description The meeting scribe session to poll, as returned by startMeetingScribe. */
7644
+ sessionId: string;
7645
+ };
7646
+ };
7647
+ };
7648
+ responses: {
7649
+ /** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
7650
+ 200: {
7651
+ headers: {
7652
+ [name: string]: unknown;
7653
+ };
7654
+ content: {
7655
+ "application/json": {
7656
+ [key: string]: unknown;
7657
+ };
7658
+ };
7659
+ };
7660
+ /** @description Validation error. */
7661
+ 400: {
7662
+ headers: {
7663
+ [name: string]: unknown;
7664
+ };
7665
+ content: {
7666
+ "application/json": components["schemas"]["ErrorResponse"];
7667
+ };
7668
+ };
7669
+ /** @description Missing or invalid credentials. */
7670
+ 401: {
7671
+ headers: {
7672
+ [name: string]: unknown;
7673
+ };
7674
+ content: {
7675
+ "application/json": components["schemas"]["ErrorResponse"];
7676
+ };
7677
+ };
7678
+ /** @description Authenticated but lacking the required permission or feature flag. */
7679
+ 403: {
7680
+ headers: {
7681
+ [name: string]: unknown;
7682
+ };
7683
+ content: {
7684
+ "application/json": components["schemas"]["ErrorResponse"];
7685
+ };
7686
+ };
7687
+ /** @description Resource not found. */
7688
+ 404: {
7689
+ headers: {
7690
+ [name: string]: unknown;
7691
+ };
7692
+ content: {
7693
+ "application/json": components["schemas"]["ErrorResponse"];
7694
+ };
7695
+ };
7696
+ /** @description Body did not match the tool's input schema. */
7697
+ 422: {
7698
+ headers: {
7699
+ [name: string]: unknown;
7700
+ };
7701
+ content: {
7702
+ "application/json": components["schemas"]["ErrorResponse"];
7703
+ };
7704
+ };
7705
+ /** @description Server error. */
7706
+ 500: {
7707
+ headers: {
7708
+ [name: string]: unknown;
7709
+ };
7710
+ content: {
7711
+ "application/json": components["schemas"]["ErrorResponse"];
7712
+ };
7713
+ };
7714
+ };
7715
+ };
7716
+ stopMeetingScribe: {
7717
+ parameters: {
7718
+ query?: never;
7719
+ header?: never;
7720
+ path?: never;
7721
+ cookie?: never;
7722
+ };
7723
+ requestBody?: {
7724
+ content: {
7725
+ "application/json": {
7726
+ /** @description The meeting scribe session to stop, as returned by startMeetingScribe. */
7727
+ sessionId: string;
7728
+ };
7729
+ };
7730
+ };
7731
+ responses: {
7732
+ /** @description Tool result (shape varies per tool — refer to the tool's docs for the exact return value). */
7733
+ 200: {
7734
+ headers: {
7735
+ [name: string]: unknown;
7736
+ };
7737
+ content: {
7738
+ "application/json": {
7739
+ [key: string]: unknown;
7740
+ };
7741
+ };
7742
+ };
7743
+ /** @description Validation error. */
7744
+ 400: {
7745
+ headers: {
7746
+ [name: string]: unknown;
7747
+ };
7748
+ content: {
7749
+ "application/json": components["schemas"]["ErrorResponse"];
7750
+ };
7751
+ };
7752
+ /** @description Missing or invalid credentials. */
7753
+ 401: {
7754
+ headers: {
7755
+ [name: string]: unknown;
7756
+ };
7757
+ content: {
7758
+ "application/json": components["schemas"]["ErrorResponse"];
7759
+ };
7760
+ };
7761
+ /** @description Authenticated but lacking the required permission or feature flag. */
7762
+ 403: {
7763
+ headers: {
7764
+ [name: string]: unknown;
7765
+ };
7766
+ content: {
7767
+ "application/json": components["schemas"]["ErrorResponse"];
7768
+ };
7769
+ };
7770
+ /** @description Resource not found. */
7771
+ 404: {
7772
+ headers: {
7773
+ [name: string]: unknown;
7774
+ };
7775
+ content: {
7776
+ "application/json": components["schemas"]["ErrorResponse"];
7777
+ };
7778
+ };
7779
+ /** @description Body did not match the tool's input schema. */
7780
+ 422: {
7781
+ headers: {
7782
+ [name: string]: unknown;
7783
+ };
7784
+ content: {
7785
+ "application/json": components["schemas"]["ErrorResponse"];
7786
+ };
7787
+ };
7788
+ /** @description Server error. */
7789
+ 500: {
7790
+ headers: {
7791
+ [name: string]: unknown;
7792
+ };
7793
+ content: {
7794
+ "application/json": components["schemas"]["ErrorResponse"];
7795
+ };
7796
+ };
7797
+ };
7798
+ };
7418
7799
  createWhiteboard: {
7419
7800
  parameters: {
7420
7801
  query?: never;
@@ -7593,6 +7974,9 @@ interface operations {
7593
7974
  requestBody?: {
7594
7975
  content: {
7595
7976
  "application/json": {
7977
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
7978
+ projectId?: string;
7979
+ /** @description Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation. */
7596
7980
  documentId: string;
7597
7981
  /** @description When true, returns the full Excalidraw scene so it can be modified and written back. */
7598
7982
  includeElements?: boolean;
@@ -7677,6 +8061,8 @@ interface operations {
7677
8061
  requestBody?: {
7678
8062
  content: {
7679
8063
  "application/json": {
8064
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
8065
+ projectId?: string;
7680
8066
  documentId: string;
7681
8067
  /** @description Elements to write. For mode 'patch', each may be a partial { id, ...changedFields } merged into the matching element by id; full Excalidraw elements for 'replace'/'append' (or new ids in 'patch'). */
7682
8068
  elements?: Record<string, never>[];
@@ -7776,6 +8162,8 @@ interface operations {
7776
8162
  requestBody?: {
7777
8163
  content: {
7778
8164
  "application/json": {
8165
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
8166
+ projectId?: string;
7779
8167
  documentId: string;
7780
8168
  /** @description Non-empty array of shape specs to append. Prefer stencils / sticky notes / architecture icons over raw rectangles wherever a standard form fits (see the `type` enum below and the tool description). */
7781
8169
  shapes: ({
@@ -8067,6 +8455,12 @@ interface operations {
8067
8455
  fileName?: string;
8068
8456
  /** @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. */
8069
8457
  locked?: boolean;
8458
+ /** @description Optional plain-language description of the image, stored on the element for accessibility and so agents reading the board later know what it depicts. */
8459
+ nlDescription?: string;
8460
+ /** @description Arbitrary Excalidraw customData stored on the element (e.g. { deckId } so a board image resolves back to its source deck). Merged with any builder-set customData. */
8461
+ customData?: {
8462
+ [key: string]: unknown;
8463
+ };
8070
8464
  };
8071
8465
  };
8072
8466
  };
@@ -8156,19 +8550,26 @@ interface operations {
8156
8550
  source: string;
8157
8551
  /** @description Optional caption shown beneath the diagram. */
8158
8552
  caption?: string;
8159
- /** @description Display width in px (aspect ratio preserved). Defaults to a capped natural size. */
8553
+ /** @description Display width in px (aspect ratio preserved). Auto-size caps at 480px; an explicit width is honoured up to 1200px. */
8160
8554
  width?: number;
8161
8555
  /** @description Display height in px (defaults from width + aspect). */
8162
8556
  height?: number;
8163
- /** @description Top-left x on the canvas. Omit to auto-place. */
8557
+ /** @description Top-left x on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given). */
8164
8558
  x?: number;
8165
- /** @description Top-left y on the canvas. Omit to auto-place. */
8559
+ /** @description Top-left y on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given). */
8166
8560
  y?: number;
8167
8561
  /**
8168
8562
  * @description Horizontal alignment relative to existing content (placed below it). Ignored if x/y given.
8169
8563
  * @enum {string}
8170
8564
  */
8171
8565
  align?: "left" | "center" | "right";
8566
+ /** @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. */
8567
+ updateElementId?: string;
8568
+ /**
8569
+ * @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.
8570
+ * @enum {string}
8571
+ */
8572
+ fit?: "contain";
8172
8573
  };
8173
8574
  };
8174
8575
  };
@@ -8354,6 +8755,8 @@ interface operations {
8354
8755
  requestBody?: {
8355
8756
  content: {
8356
8757
  "application/json": {
8758
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
8759
+ projectId?: string;
8357
8760
  /** @description The whiteboard's documentId. */
8358
8761
  documentId: string;
8359
8762
  /** @description Rows as arrays of cell strings. If headers is omitted, the first row is treated as the header row. */
@@ -8540,7 +8943,9 @@ interface operations {
8540
8943
  requestBody?: {
8541
8944
  content: {
8542
8945
  "application/json": {
8543
- /** @description The whiteboard's documentId. */
8946
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
8947
+ projectId?: string;
8948
+ /** @description The whiteboard's documentId. Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation. */
8544
8949
  documentId: string;
8545
8950
  /** @description Render only these element ids (plus their bound labels + group peers) instead of the whole board. */
8546
8951
  elementIds?: string[];
@@ -8644,6 +9049,8 @@ interface operations {
8644
9049
  content: {
8645
9050
  "application/json": {
8646
9051
  documentId: string;
9052
+ /** @description Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID. */
9053
+ projectId?: string;
8647
9054
  };
8648
9055
  };
8649
9056
  };
@@ -9000,10 +9407,13 @@ interface operations {
9000
9407
  requestBody?: {
9001
9408
  content: {
9002
9409
  "application/json": {
9003
- /** @description List of document position updates. All documents must belong to the same project. */
9410
+ /** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
9004
9411
  items: {
9005
9412
  documentId: string;
9413
+ /** @description Sort position among siblings. Non-negative integer. */
9006
9414
  position: number;
9415
+ /** @description Optional. MOVE the document into this folder; null moves it to the project root. Omit to leave its current folder untouched. The folder must exist and belong to the same project. */
9416
+ folderId?: string | null;
9007
9417
  }[];
9008
9418
  };
9009
9419
  };
@@ -9086,6 +9496,9 @@ interface operations {
9086
9496
  requestBody?: {
9087
9497
  content: {
9088
9498
  "application/json": {
9499
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
9500
+ projectId?: string;
9501
+ /** @description Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
9089
9502
  documentId: string;
9090
9503
  /** @description Filter to a specific version. */
9091
9504
  versionNumber?: number;
@@ -9266,6 +9679,8 @@ interface operations {
9266
9679
  requestBody?: {
9267
9680
  content: {
9268
9681
  "application/json": {
9682
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
9683
+ projectId?: string;
9269
9684
  documentId: string;
9270
9685
  /** @description Original filename (e.g. screenshot.png). */
9271
9686
  fileName: string;
@@ -9354,9 +9769,11 @@ interface operations {
9354
9769
  requestBody?: {
9355
9770
  content: {
9356
9771
  "application/json": {
9772
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
9773
+ projectId?: string;
9357
9774
  documentId: string;
9358
- /** @description Version timestamp from getDocument() for optimistic locking. */
9359
- documentVersionTimestamp: number;
9775
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
9776
+ documentVersionTimestamp?: number;
9360
9777
  /** @description Base64-encoded image data. Mutually exclusive with imageBinary/imageUrl. */
9361
9778
  imageBase64?: string;
9362
9779
  /** @description Raw binary as byte array. Mutually exclusive with imageBase64/imageUrl. */
@@ -9465,8 +9882,8 @@ interface operations {
9465
9882
  "application/json": {
9466
9883
  /** @description Image ID from IMAGE_OMITTED markers. */
9467
9884
  imageId: string;
9468
- /** @description Version timestamp from getDocument() for optimistic locking. */
9469
- documentVersionTimestamp: number;
9885
+ /** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
9886
+ documentVersionTimestamp?: number;
9470
9887
  /** @description New alt text. */
9471
9888
  alt?: string;
9472
9889
  /** @description New image description. */
@@ -9646,6 +10063,8 @@ interface operations {
9646
10063
  requestBody?: {
9647
10064
  content: {
9648
10065
  "application/json": {
10066
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
10067
+ projectId?: string;
9649
10068
  documentId: string;
9650
10069
  /** @description Original filename (e.g. sales-data.csv). Extension auto-detects content type. */
9651
10070
  fileName: string;
@@ -9732,6 +10151,8 @@ interface operations {
9732
10151
  requestBody?: {
9733
10152
  content: {
9734
10153
  "application/json": {
10154
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
10155
+ projectId?: string;
9735
10156
  documentId: string;
9736
10157
  /** @description Attachment ID to delete. */
9737
10158
  attachmentId: string;
@@ -10196,6 +10617,9 @@ interface operations {
10196
10617
  requestBody?: {
10197
10618
  content: {
10198
10619
  "application/json": {
10620
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
10621
+ projectId?: string;
10622
+ /** @description Accepts either the UUID or the friendly id (e.g. IMP-42); friendly ids are resolved within your organisation. */
10199
10623
  improvementId: string;
10200
10624
  };
10201
10625
  };
@@ -10280,7 +10704,7 @@ interface operations {
10280
10704
  "application/json": {
10281
10705
  projectId: string;
10282
10706
  title: string;
10283
- /** @description Type. Default: enhancement. Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. Setting type='task' makes the row a task (TAS- prefix); any other type makes it a non-task improvement (IMP- prefix). */
10707
+ /** @description Type. Default: enhancement. Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. Despite the tool's name there is no 'improvement' value — pass it and it is accepted as an alias for 'enhancement', which is also the default. Setting type='task' makes the row a task (TAS- prefix); any other type makes it a non-task improvement (IMP- prefix). */
10284
10708
  type?: string;
10285
10709
  /** @description Priority. Default: medium. */
10286
10710
  priority?: string;
@@ -10302,6 +10726,12 @@ interface operations {
10302
10726
  /** @description Optional — server mints one if omitted. Preserve on edits. */
10303
10727
  id?: string;
10304
10728
  text: string;
10729
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
10730
+ updated_at?: string;
10731
+ /** @description Server-stamped user id. Echo back unchanged. */
10732
+ updated_by?: string;
10733
+ /** @description Server-stamped credential label. Echo back unchanged. */
10734
+ updated_by_credential_name?: string;
10305
10735
  }[];
10306
10736
  /** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
10307
10737
  checklist?: {
@@ -10312,6 +10742,18 @@ interface operations {
10312
10742
  due_date?: string;
10313
10743
  /** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
10314
10744
  completed?: boolean;
10745
+ /** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
10746
+ completed_at?: string;
10747
+ /** @description Server-stamped user id. Echo back unchanged. */
10748
+ completed_by?: string;
10749
+ /** @description Server-stamped credential label. Echo back unchanged. */
10750
+ completed_by_credential_name?: string;
10751
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
10752
+ updated_at?: string;
10753
+ /** @description Server-stamped user id. Echo back unchanged. */
10754
+ updated_by?: string;
10755
+ /** @description Server-stamped credential label. Echo back unchanged. */
10756
+ updated_by_credential_name?: string;
10315
10757
  }[];
10316
10758
  constraints?: string[];
10317
10759
  non_goals?: string[];
@@ -10351,6 +10793,12 @@ interface operations {
10351
10793
  wbs_code?: string;
10352
10794
  /** @description Progress percentage (0-100). Null means not tracked. */
10353
10795
  percent_complete?: number;
10796
+ source_channel?: string;
10797
+ impacted_repositories?: string[];
10798
+ /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
10799
+ relationships?: Record<string, never>;
10800
+ /** @description Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces. */
10801
+ metadata?: Record<string, never>;
10354
10802
  };
10355
10803
  };
10356
10804
  };
@@ -10432,6 +10880,8 @@ interface operations {
10432
10880
  requestBody?: {
10433
10881
  content: {
10434
10882
  "application/json": {
10883
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
10884
+ projectId?: string;
10435
10885
  improvementId: string;
10436
10886
  /** @description Version timestamp from getImprovement() for optimistic locking. */
10437
10887
  versionTimestamp: number;
@@ -10462,6 +10912,12 @@ interface operations {
10462
10912
  /** @description Optional — server mints one if omitted. Preserve on edits. */
10463
10913
  id?: string;
10464
10914
  text: string;
10915
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
10916
+ updated_at?: string;
10917
+ /** @description Server-stamped user id. Echo back unchanged. */
10918
+ updated_by?: string;
10919
+ /** @description Server-stamped credential label. Echo back unchanged. */
10920
+ updated_by_credential_name?: string;
10465
10921
  }[];
10466
10922
  /** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
10467
10923
  checklist?: {
@@ -10472,6 +10928,18 @@ interface operations {
10472
10928
  due_date?: string;
10473
10929
  /** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
10474
10930
  completed?: boolean;
10931
+ /** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
10932
+ completed_at?: string;
10933
+ /** @description Server-stamped user id. Echo back unchanged. */
10934
+ completed_by?: string;
10935
+ /** @description Server-stamped credential label. Echo back unchanged. */
10936
+ completed_by_credential_name?: string;
10937
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
10938
+ updated_at?: string;
10939
+ /** @description Server-stamped user id. Echo back unchanged. */
10940
+ updated_by?: string;
10941
+ /** @description Server-stamped credential label. Echo back unchanged. */
10942
+ updated_by_credential_name?: string;
10475
10943
  }[];
10476
10944
  constraints?: string[];
10477
10945
  non_goals?: string[];
@@ -10497,11 +10965,14 @@ interface operations {
10497
10965
  rejection_comment?: string;
10498
10966
  /** @description Required when status=done. */
10499
10967
  completion_comment?: string;
10500
- /** @description Required when reopening from blocked/rejected/done/deferred. */
10968
+ /** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
10501
10969
  reopened_comment?: string;
10502
- /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
10970
+ /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
10503
10971
  relationships?: Record<string, never>;
10972
+ /** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
10504
10973
  metadata?: Record<string, never>;
10974
+ /** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
10975
+ metadata_replace?: boolean;
10505
10976
  /** @description Link to plan. Null to unlink. */
10506
10977
  plan_id?: string;
10507
10978
  /** @description Assign to phase. Null to unassign. */
@@ -10593,6 +11064,8 @@ interface operations {
10593
11064
  requestBody?: {
10594
11065
  content: {
10595
11066
  "application/json": {
11067
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
11068
+ projectId?: string;
10596
11069
  improvementId: string;
10597
11070
  };
10598
11071
  };
@@ -11107,6 +11580,8 @@ interface operations {
11107
11580
  requestBody?: {
11108
11581
  content: {
11109
11582
  "application/json": {
11583
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
11584
+ projectId?: string;
11110
11585
  improvementId: string;
11111
11586
  /** @description Summary of the evidence. */
11112
11587
  summary: string;
@@ -11201,6 +11676,8 @@ interface operations {
11201
11676
  requestBody?: {
11202
11677
  content: {
11203
11678
  "application/json": {
11679
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
11680
+ projectId?: string;
11204
11681
  improvementId: string;
11205
11682
  /** @description Type: comment, agent_update, field_change. Default: comment. */
11206
11683
  activityType?: string;
@@ -11660,6 +12137,9 @@ interface operations {
11660
12137
  requestBody?: {
11661
12138
  content: {
11662
12139
  "application/json": {
12140
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12141
+ projectId?: string;
12142
+ /** @description Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation. */
11663
12143
  planId: string;
11664
12144
  };
11665
12145
  };
@@ -11842,6 +12322,8 @@ interface operations {
11842
12322
  requestBody?: {
11843
12323
  content: {
11844
12324
  "application/json": {
12325
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12326
+ projectId?: string;
11845
12327
  planId: string;
11846
12328
  /** @description Version timestamp from getPlan() for optimistic locking. */
11847
12329
  versionTimestamp: number;
@@ -11942,6 +12424,8 @@ interface operations {
11942
12424
  requestBody?: {
11943
12425
  content: {
11944
12426
  "application/json": {
12427
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12428
+ projectId?: string;
11945
12429
  planId: string;
11946
12430
  };
11947
12431
  };
@@ -12106,6 +12590,9 @@ interface operations {
12106
12590
  requestBody?: {
12107
12591
  content: {
12108
12592
  "application/json": {
12593
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12594
+ projectId?: string;
12595
+ /** @description Accepts either the UUID or the friendly id (e.g. PHA-7); friendly ids are resolved within your organisation. */
12109
12596
  phaseId: string;
12110
12597
  };
12111
12598
  };
@@ -12289,6 +12776,8 @@ interface operations {
12289
12776
  requestBody?: {
12290
12777
  content: {
12291
12778
  "application/json": {
12779
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12780
+ projectId?: string;
12292
12781
  phaseId: string;
12293
12782
  /** @description Version timestamp from getPlanPhase() for optimistic locking. */
12294
12783
  versionTimestamp: number;
@@ -12388,6 +12877,8 @@ interface operations {
12388
12877
  requestBody?: {
12389
12878
  content: {
12390
12879
  "application/json": {
12880
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
12881
+ projectId?: string;
12391
12882
  phaseId: string;
12392
12883
  };
12393
12884
  };
@@ -12556,6 +13047,8 @@ interface operations {
12556
13047
  requestBody?: {
12557
13048
  content: {
12558
13049
  "application/json": {
13050
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
13051
+ projectId?: string;
12559
13052
  planId: string;
12560
13053
  /** @description Type: comment, agent_update, field_change. Default: comment. */
12561
13054
  activityType?: string;
@@ -12825,17 +13318,35 @@ interface operations {
12825
13318
  /** @description Phase to assign to. */
12826
13319
  phaseId?: string;
12827
13320
  description?: string;
12828
- /** @description Type. Default: task. Tasks created in plans are typed 'task' (friendly_id prefix TAS-). Override only if you want the row to appear as a non-task improvement (IMP- prefix). */
13321
+ /** @description Type. Default: task. Tasks created in plans are typed 'task' (friendly_id prefix TAS-). Override only if you want the row to appear as a non-task improvement (IMP- prefix). Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. */
12829
13322
  type?: string;
12830
13323
  /** @description Initial status. Default: captured. */
12831
13324
  status?: string;
12832
13325
  /** @description Priority. Default: medium. */
12833
13326
  priority?: string;
13327
+ /** @description e.g. this_week, this_month, this_quarter. */
13328
+ urgency?: string;
13329
+ /** @description Where this task came from (free text, e.g. 'meeting', 'compliance-scan'). Stored for provenance and shown in the improvement/task record. */
13330
+ source?: string;
13331
+ source_channel?: string;
13332
+ /** @description Category ID. */
13333
+ category_id?: string;
13334
+ problem_statement?: string;
13335
+ desired_outcome?: string;
13336
+ business_impact?: string;
13337
+ user_impact?: string;
13338
+ why_now?: string;
12834
13339
  /** @description Acceptance criteria — ordered list of pass/fail statements that define "done" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `["row 1", "row 2"]`) and auto-converted to `{ id, text }`. */
12835
13340
  acceptance_criteria?: {
12836
13341
  /** @description Optional — server mints one if omitted. Preserve on edits. */
12837
13342
  id?: string;
12838
13343
  text: string;
13344
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
13345
+ updated_at?: string;
13346
+ /** @description Server-stamped user id. Echo back unchanged. */
13347
+ updated_by?: string;
13348
+ /** @description Server-stamped credential label. Echo back unchanged. */
13349
+ updated_by_credential_name?: string;
12839
13350
  }[];
12840
13351
  /** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
12841
13352
  checklist?: {
@@ -12846,7 +13357,37 @@ interface operations {
12846
13357
  due_date?: string;
12847
13358
  /** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
12848
13359
  completed?: boolean;
13360
+ /** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
13361
+ completed_at?: string;
13362
+ /** @description Server-stamped user id. Echo back unchanged. */
13363
+ completed_by?: string;
13364
+ /** @description Server-stamped credential label. Echo back unchanged. */
13365
+ completed_by_credential_name?: string;
13366
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
13367
+ updated_at?: string;
13368
+ /** @description Server-stamped user id. Echo back unchanged. */
13369
+ updated_by?: string;
13370
+ /** @description Server-stamped credential label. Echo back unchanged. */
13371
+ updated_by_credential_name?: string;
12849
13372
  }[];
13373
+ constraints?: string[];
13374
+ non_goals?: string[];
13375
+ /** @description Array of {id, title}. */
13376
+ impacted_documents?: Record<string, never>[];
13377
+ /** @description Document IDs to link. Titles resolved automatically. */
13378
+ linked_document_ids?: string[];
13379
+ /** @description Array of {id, name}. */
13380
+ impacted_diagrams?: Record<string, never>[];
13381
+ impacted_components?: string[];
13382
+ impacted_repositories?: string[];
13383
+ agent_ready?: boolean;
13384
+ agent_missing_info?: string[];
13385
+ agent_recommended_action?: string;
13386
+ /** @description low, medium, high, very_high. */
13387
+ agent_complexity?: string;
13388
+ /** @description 0.00 to 1.00. */
13389
+ agent_confidence?: number;
13390
+ agent_brief?: string;
12850
13391
  /** @description User UUID to assign as owner. MUTUALLY EXCLUSIVE with owner_team_id. Use listAssignablePrincipals(projectId, kind='user') to look up valid UUIDs. */
12851
13392
  owner_id?: string;
12852
13393
  /** @description Team UUID to assign as owner (assigns the whole team). MUTUALLY EXCLUSIVE with owner_id. Use listTeams or listAssignablePrincipals(kind='team') to look up valid UUIDs. */
@@ -12861,6 +13402,10 @@ interface operations {
12861
13402
  position?: number;
12862
13403
  /** @description Progress percentage (0-100). Null means not tracked. */
12863
13404
  percent_complete?: number;
13405
+ /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
13406
+ relationships?: Record<string, never>;
13407
+ /** @description Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces. */
13408
+ metadata?: Record<string, never>;
12864
13409
  };
12865
13410
  };
12866
13411
  };
@@ -13044,6 +13589,9 @@ interface operations {
13044
13589
  requestBody?: {
13045
13590
  content: {
13046
13591
  "application/json": {
13592
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
13593
+ projectId?: string;
13594
+ /** @description Accepts either the UUID or the friendly id (e.g. TAS-176); friendly ids are resolved within your organisation. */
13047
13595
  taskId: string;
13048
13596
  };
13049
13597
  };
@@ -13126,6 +13674,8 @@ interface operations {
13126
13674
  requestBody?: {
13127
13675
  content: {
13128
13676
  "application/json": {
13677
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
13678
+ projectId?: string;
13129
13679
  taskId: string;
13130
13680
  /** @description Version timestamp from getTask() for optimistic locking. */
13131
13681
  versionTimestamp: number;
@@ -13159,6 +13709,12 @@ interface operations {
13159
13709
  /** @description Optional — server mints one if omitted. Preserve on edits. */
13160
13710
  id?: string;
13161
13711
  text: string;
13712
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
13713
+ updated_at?: string;
13714
+ /** @description Server-stamped user id. Echo back unchanged. */
13715
+ updated_by?: string;
13716
+ /** @description Server-stamped credential label. Echo back unchanged. */
13717
+ updated_by_credential_name?: string;
13162
13718
  }[];
13163
13719
  /** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
13164
13720
  checklist?: {
@@ -13169,6 +13725,18 @@ interface operations {
13169
13725
  due_date?: string;
13170
13726
  /** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
13171
13727
  completed?: boolean;
13728
+ /** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
13729
+ completed_at?: string;
13730
+ /** @description Server-stamped user id. Echo back unchanged. */
13731
+ completed_by?: string;
13732
+ /** @description Server-stamped credential label. Echo back unchanged. */
13733
+ completed_by_credential_name?: string;
13734
+ /** @description Server-stamped. Echo back unchanged; ignored on new rows. */
13735
+ updated_at?: string;
13736
+ /** @description Server-stamped user id. Echo back unchanged. */
13737
+ updated_by?: string;
13738
+ /** @description Server-stamped credential label. Echo back unchanged. */
13739
+ updated_by_credential_name?: string;
13172
13740
  }[];
13173
13741
  constraints?: string[];
13174
13742
  non_goals?: string[];
@@ -13194,11 +13762,14 @@ interface operations {
13194
13762
  rejection_comment?: string;
13195
13763
  /** @description Required when status=done. */
13196
13764
  completion_comment?: string;
13197
- /** @description Required when reopening from a closed status. */
13765
+ /** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
13198
13766
  reopened_comment?: string;
13199
- /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
13767
+ /** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
13200
13768
  relationships?: Record<string, never>;
13769
+ /** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
13201
13770
  metadata?: Record<string, never>;
13771
+ /** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
13772
+ metadata_replace?: boolean;
13202
13773
  /** @description Link to plan. Null to unlink. */
13203
13774
  plan_id?: string;
13204
13775
  /** @description Assign to phase. Null to unassign. */
@@ -13284,6 +13855,9 @@ interface operations {
13284
13855
  requestBody?: {
13285
13856
  content: {
13286
13857
  "application/json": {
13858
+ /** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
13859
+ projectId?: string;
13860
+ /** @description Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation. */
13287
13861
  planId: string;
13288
13862
  };
13289
13863
  };
@@ -14148,7 +14722,9 @@ interface operations {
14148
14722
  * @enum {string}
14149
14723
  */
14150
14724
  mode?: "local" | "global" | "graph" | "path" | "ppr";
14725
+ /** @description STRONGLY RECOMMENDED — in practice required. The KG is scoped per project/workspace and there is usually no organisation-wide default, so a call with no projectId and no workspaceId typically matches no scope rule and returns nothing useful. Use listProjects to find the id. */
14151
14726
  projectId?: string;
14727
+ /** @description Alternative to projectId — searches the whole workspace subtree. Give one of the two. */
14152
14728
  workspaceId?: string;
14153
14729
  /** @description Required for mode='path'. Optional source entity for mode='graph'. */
14154
14730
  srcEntityId?: string;
@@ -14327,6 +14903,8 @@ interface operations {
14327
14903
  "application/json": {
14328
14904
  entityId?: string;
14329
14905
  name?: string;
14906
+ /** @description Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects. */
14907
+ projectId?: string;
14330
14908
  };
14331
14909
  };
14332
14910
  };