@knowledge-stack/ksapi 1.104.0 → 1.105.0

package/.openapi-generator/FILES

@@ -236,6 +236,7 @@ docs/SetApprovalStateRequest.md
 docs/SetWorkflowRunApprovalRequest.md
 docs/SignInRequest.md
 docs/SortDirection.md
+docs/StartWorkflowRunRequest.md
 docs/StepInput.md
 docs/StepKind.md
 docs/StepOutput.md
@@ -577,6 +578,7 @@ src/models/SetApprovalStateRequest.ts
 src/models/SetWorkflowRunApprovalRequest.ts
 src/models/SignInRequest.ts
 src/models/SortDirection.ts
+src/models/StartWorkflowRunRequest.ts
 src/models/StepInput.ts
 src/models/StepKind.ts
 src/models/StepOutput.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.104.0
+# @knowledge-stack/ksapi@1.105.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -247,7 +247,7 @@ All URIs are relative to *http://localhost:8000*
 *WorkflowRunsApi* | [**listWorkflowRunsForTenant**](docs/WorkflowRunsApi.md#listworkflowrunsfortenant) | **GET** /v1/workflow-runs | List Workflow Runs For Tenant Handler
 *WorkflowRunsApi* | [**retryWorkflowRun**](docs/WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler
 *WorkflowRunsApi* | [**setWorkflowRunApproval**](docs/WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler
-*WorkflowRunsApi* | [**startWorkflowRun**](docs/WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler
+*WorkflowRunsApi* | [**startWorkflowRun**](docs/WorkflowRunsApi.md#startworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler
 *WorkflowRunsApi* | [**stopWorkflowRun**](docs/WorkflowRunsApi.md#stopworkflowrun) | **POST** /v1/workflow-runs/{run_id}/stop | Stop Workflow Run Handler
 *WorkflowRunsApi* | [**updateWorkflowRun**](docs/WorkflowRunsApi.md#updateworkflowrunoperation) | **PATCH** /v1/workflow-runs/{run_id} | Update Workflow Run Handler
 *WorkflowRunsApi* | [**workflowRunCallback**](docs/WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler
@@ -473,6 +473,7 @@ All URIs are relative to *http://localhost:8000*
 - [SetWorkflowRunApprovalRequest](docs/SetWorkflowRunApprovalRequest.md)
 - [SignInRequest](docs/SignInRequest.md)
 - [SortDirection](docs/SortDirection.md)
+- [StartWorkflowRunRequest](docs/StartWorkflowRunRequest.md)
 - [StepInput](docs/StepInput.md)
 - [StepKind](docs/StepKind.md)
 - [StepOutput](docs/StepOutput.md)
@@ -576,7 +577,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.104.0`
+- Package version: `1.105.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/WorkflowRunsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
+import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
 export interface CloneWorkflowRunOperationRequest {
     runId: string;
     cloneWorkflowRunRequest: CloneWorkflowRunRequest;
@@ -48,8 +48,9 @@ export interface SetWorkflowRunApprovalOperationRequest {
     runId: string;
     setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
 }
-export interface StartWorkflowRunRequest {
+export interface StartWorkflowRunOperationRequest {
     runId: string;
+    startWorkflowRunRequest?: StartWorkflowRunRequest | null;
 }
 export interface StopWorkflowRunRequest {
     runId: string;
@@ -249,24 +250,26 @@ export interface WorkflowRunsApiInterface {
     /**
      * Creates request options for startWorkflowRun without sending the request
      * @param {string} runId
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
+    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * @summary Start Workflow Run Handler
      * @param {string} runId
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+    startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+    startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
     /**
      * Creates request options for stopWorkflowRun without sending the request
      * @param {string} runId
@@ -436,17 +439,17 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
     /**
      * Creates request options for startWorkflowRun without sending the request
      */
-    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
+    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+    startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+    startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
     /**
      * Creates request options for stopWorkflowRun without sending the request
      */

package/dist/apis/WorkflowRunsApi.js

@@ -453,6 +453,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
                 const tokenString = yield token("bearerAuth", []);
@@ -467,11 +468,12 @@ class WorkflowRunsApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
+                body: (0, index_1.StartWorkflowRunRequestToJSON)(requestParameters['startWorkflowRunRequest']),
             };
         });
     }
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
     startWorkflowRunRaw(requestParameters, initOverrides) {
@@ -482,7 +484,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
     startWorkflowRun(requestParameters, initOverrides) {

package/dist/esm/apis/WorkflowRunsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
+import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
 export interface CloneWorkflowRunOperationRequest {
     runId: string;
     cloneWorkflowRunRequest: CloneWorkflowRunRequest;
@@ -48,8 +48,9 @@ export interface SetWorkflowRunApprovalOperationRequest {
     runId: string;
     setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
 }
-export interface StartWorkflowRunRequest {
+export interface StartWorkflowRunOperationRequest {
     runId: string;
+    startWorkflowRunRequest?: StartWorkflowRunRequest | null;
 }
 export interface StopWorkflowRunRequest {
     runId: string;
@@ -249,24 +250,26 @@ export interface WorkflowRunsApiInterface {
     /**
      * Creates request options for startWorkflowRun without sending the request
      * @param {string} runId
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
+    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * @summary Start Workflow Run Handler
      * @param {string} runId
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+    startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+    startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
     /**
      * Creates request options for stopWorkflowRun without sending the request
      * @param {string} runId
@@ -436,17 +439,17 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
     /**
      * Creates request options for startWorkflowRun without sending the request
      */
-    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
+    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+    startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+    startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
     /**
      * Creates request options for stopWorkflowRun without sending the request
      */

package/dist/esm/apis/WorkflowRunsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CloneWorkflowRunRequestToJSON, PaginatedResponseWorkflowRunResponseFromJSON, SetWorkflowRunApprovalRequestToJSON, UpdateWorkflowRunRequestToJSON, WorkflowCallbackResponseFromJSON, WorkflowRunCallbackRequestToJSON, WorkflowRunResponseFromJSON, WorkflowRunSummaryResponseFromJSON, } from '../models/index';
+import { CloneWorkflowRunRequestToJSON, PaginatedResponseWorkflowRunResponseFromJSON, SetWorkflowRunApprovalRequestToJSON, StartWorkflowRunRequestToJSON, UpdateWorkflowRunRequestToJSON, WorkflowCallbackResponseFromJSON, WorkflowRunCallbackRequestToJSON, WorkflowRunResponseFromJSON, WorkflowRunSummaryResponseFromJSON, } from '../models/index';
 /**
  *
  */
@@ -417,6 +417,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
                 const tokenString = yield token("bearerAuth", []);
@@ -431,11 +432,12 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
+                body: StartWorkflowRunRequestToJSON(requestParameters['startWorkflowRunRequest']),
             };
         });
     }
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
     startWorkflowRunRaw(requestParameters, initOverrides) {
@@ -446,7 +448,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
     startWorkflowRun(requestParameters, initOverrides) {

package/dist/esm/models/StartWorkflowRunRequest.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.
+ *
+ * The whole body is optional: an absent body starts the run with just
+ * the localized "Started workflow: X" opening message, exactly as
+ * before. When ``user_message`` is set it is appended to that opening
+ * thread message AND injected into the runner's first user turn, so the
+ * agent acts on it as guidance layered on the workflow instruction.
+ * @export
+ * @interface StartWorkflowRunRequest
+ */
+export interface StartWorkflowRunRequest {
+    /**
+     * Free-text instruction shown in the run thread and passed to the agent as additional guidance on top of the workflow instruction. Optional.
+     * @type {string}
+     * @memberof StartWorkflowRunRequest
+     */
+    userMessage?: string | null;
+}
+export declare const StartWorkflowRunRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+export declare function instanceOfStartWorkflowRunRequest(value: object): value is StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestFromJSON(json: any): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestToJSON(json: any): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestToJSONTyped(value?: StartWorkflowRunRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StartWorkflowRunRequest.js

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const StartWorkflowRunRequestPropertyValidationAttributesMap = {
+    userMessage: {
+        maxLength: 4000,
+    },
+};
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+export function instanceOfStartWorkflowRunRequest(value) {
+    return true;
+}
+export function StartWorkflowRunRequestFromJSON(json) {
+    return StartWorkflowRunRequestFromJSONTyped(json, false);
+}
+export function StartWorkflowRunRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
+    };
+}
+export function StartWorkflowRunRequestToJSON(json) {
+    return StartWorkflowRunRequestToJSONTyped(json, false);
+}
+export function StartWorkflowRunRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_message': value['userMessage'],
+    };
+}

package/dist/esm/models/WorkflowRunSnapshot.d.ts

@@ -49,6 +49,12 @@ export interface WorkflowRunSnapshot {
      * @memberof WorkflowRunSnapshot
      */
     inputs: Array<InputSnapshot>;
+    /**
+     * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    userMessage?: string | null;
 }
 export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/WorkflowRunSnapshot.js

@@ -13,7 +13,11 @@
  */
 import { InputSnapshotFromJSON, InputSnapshotToJSON, } from './InputSnapshot';
 import { InstructionSnapshotFromJSON, InstructionSnapshotToJSON, } from './InstructionSnapshot';
-export const WorkflowRunSnapshotPropertyValidationAttributesMap = {};
+export const WorkflowRunSnapshotPropertyValidationAttributesMap = {
+    userMessage: {
+        maxLength: 4000,
+    },
+};
 /**
  * Check if a given object implements the WorkflowRunSnapshot interface.
  */
@@ -40,6 +44,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'instruction': InstructionSnapshotFromJSON(json['instruction']),
         'inputs': (json['inputs'].map(InputSnapshotFromJSON)),
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
     };
 }
 export function WorkflowRunSnapshotToJSON(json) {
@@ -54,5 +59,6 @@ export function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = fals
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'instruction': InstructionSnapshotToJSON(value['instruction']),
         'inputs': (value['inputs'].map(InputSnapshotToJSON)),
+        'user_message': value['userMessage'],
     };
 }

package/dist/esm/models/index.d.ts

@@ -211,6 +211,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SignInRequest';
 export * from './SortDirection';
+export * from './StartWorkflowRunRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';

package/dist/esm/models/index.js

@@ -213,6 +213,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SignInRequest';
 export * from './SortDirection';
+export * from './StartWorkflowRunRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';

package/dist/models/StartWorkflowRunRequest.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.
+ *
+ * The whole body is optional: an absent body starts the run with just
+ * the localized "Started workflow: X" opening message, exactly as
+ * before. When ``user_message`` is set it is appended to that opening
+ * thread message AND injected into the runner's first user turn, so the
+ * agent acts on it as guidance layered on the workflow instruction.
+ * @export
+ * @interface StartWorkflowRunRequest
+ */
+export interface StartWorkflowRunRequest {
+    /**
+     * Free-text instruction shown in the run thread and passed to the agent as additional guidance on top of the workflow instruction. Optional.
+     * @type {string}
+     * @memberof StartWorkflowRunRequest
+     */
+    userMessage?: string | null;
+}
+export declare const StartWorkflowRunRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+export declare function instanceOfStartWorkflowRunRequest(value: object): value is StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestFromJSON(json: any): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestToJSON(json: any): StartWorkflowRunRequest;
+export declare function StartWorkflowRunRequestToJSONTyped(value?: StartWorkflowRunRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StartWorkflowRunRequest.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartWorkflowRunRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfStartWorkflowRunRequest = instanceOfStartWorkflowRunRequest;
+exports.StartWorkflowRunRequestFromJSON = StartWorkflowRunRequestFromJSON;
+exports.StartWorkflowRunRequestFromJSONTyped = StartWorkflowRunRequestFromJSONTyped;
+exports.StartWorkflowRunRequestToJSON = StartWorkflowRunRequestToJSON;
+exports.StartWorkflowRunRequestToJSONTyped = StartWorkflowRunRequestToJSONTyped;
+exports.StartWorkflowRunRequestPropertyValidationAttributesMap = {
+    userMessage: {
+        maxLength: 4000,
+    },
+};
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+function instanceOfStartWorkflowRunRequest(value) {
+    return true;
+}
+function StartWorkflowRunRequestFromJSON(json) {
+    return StartWorkflowRunRequestFromJSONTyped(json, false);
+}
+function StartWorkflowRunRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
+    };
+}
+function StartWorkflowRunRequestToJSON(json) {
+    return StartWorkflowRunRequestToJSONTyped(json, false);
+}
+function StartWorkflowRunRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_message': value['userMessage'],
+    };
+}

package/dist/models/WorkflowRunSnapshot.d.ts

@@ -49,6 +49,12 @@ export interface WorkflowRunSnapshot {
      * @memberof WorkflowRunSnapshot
      */
     inputs: Array<InputSnapshot>;
+    /**
+     * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    userMessage?: string | null;
 }
 export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/WorkflowRunSnapshot.js

@@ -21,7 +21,11 @@ exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
 exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
 const InputSnapshot_1 = require("./InputSnapshot");
 const InstructionSnapshot_1 = require("./InstructionSnapshot");
-exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {};
+exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {
+    userMessage: {
+        maxLength: 4000,
+    },
+};
 /**
  * Check if a given object implements the WorkflowRunSnapshot interface.
  */
@@ -48,6 +52,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'instruction': (0, InstructionSnapshot_1.InstructionSnapshotFromJSON)(json['instruction']),
         'inputs': (json['inputs'].map(InputSnapshot_1.InputSnapshotFromJSON)),
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
     };
 }
 function WorkflowRunSnapshotToJSON(json) {
@@ -62,5 +67,6 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'instruction': (0, InstructionSnapshot_1.InstructionSnapshotToJSON)(value['instruction']),
         'inputs': (value['inputs'].map(InputSnapshot_1.InputSnapshotToJSON)),
+        'user_message': value['userMessage'],
     };
 }

package/dist/models/index.d.ts

@@ -211,6 +211,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SignInRequest';
 export * from './SortDirection';
+export * from './StartWorkflowRunRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';

package/dist/models/index.js

@@ -229,6 +229,7 @@ __exportStar(require("./SetApprovalStateRequest"), exports);
 __exportStar(require("./SetWorkflowRunApprovalRequest"), exports);
 __exportStar(require("./SignInRequest"), exports);
 __exportStar(require("./SortDirection"), exports);
+__exportStar(require("./StartWorkflowRunRequest"), exports);
 __exportStar(require("./StepInput"), exports);
 __exportStar(require("./StepKind"), exports);
 __exportStar(require("./StepOutput"), exports);

package/docs/StartWorkflowRunRequest.md

@@ -0,0 +1,35 @@
+
+# StartWorkflowRunRequest
+
+Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.  The whole body is optional: an absent body starts the run with just the localized \"Started workflow: X\" opening message, exactly as before. When ``user_message`` is set it is appended to that opening thread message AND injected into the runner\'s first user turn, so the agent acts on it as guidance layered on the workflow instruction.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userMessage` | string
+
+## Example
+
+```typescript
+import type { StartWorkflowRunRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userMessage": null,
+} satisfies StartWorkflowRunRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as StartWorkflowRunRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WorkflowRunSnapshot.md

@@ -11,6 +11,7 @@ Name | Type
 `maxRunDurationSeconds` | number
 `instruction` | [InstructionSnapshot](InstructionSnapshot.md)
 `inputs` | [Array<InputSnapshot>](InputSnapshot.md)
+`userMessage` | string
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "maxRunDurationSeconds": null,
   "instruction": null,
   "inputs": null,
+  "userMessage": null,
 } satisfies WorkflowRunSnapshot
 
 console.log(example)

package/docs/WorkflowRunsApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost:8000*
 | [**listWorkflowRunsForTenant**](WorkflowRunsApi.md#listworkflowrunsfortenant) | **GET** /v1/workflow-runs | List Workflow Runs For Tenant Handler |
 | [**retryWorkflowRun**](WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler |
 | [**setWorkflowRunApproval**](WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler |
-| [**startWorkflowRun**](WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler |
+| [**startWorkflowRun**](WorkflowRunsApi.md#startworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler |
 | [**stopWorkflowRun**](WorkflowRunsApi.md#stopworkflowrun) | **POST** /v1/workflow-runs/{run_id}/stop | Stop Workflow Run Handler |
 | [**updateWorkflowRun**](WorkflowRunsApi.md#updateworkflowrunoperation) | **PATCH** /v1/workflow-runs/{run_id} | Update Workflow Run Handler |
 | [**workflowRunCallback**](WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler |
@@ -589,11 +589,11 @@ example().catch(console.error);
 
 ## startWorkflowRun
 
-> WorkflowRunResponse startWorkflowRun(runId)
+> WorkflowRunResponse startWorkflowRun(runId, startWorkflowRunRequest)
 
 Start Workflow Run Handler
 
-Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
 
 ### Example
 
@@ -602,7 +602,7 @@ import {
   Configuration,
   WorkflowRunsApi,
 } from '@knowledge-stack/ksapi';
-import type { StartWorkflowRunRequest } from '@knowledge-stack/ksapi';
+import type { StartWorkflowRunOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -617,7 +617,9 @@ async function example() {
   const body = {
     // string
     runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-  } satisfies StartWorkflowRunRequest;
+    // StartWorkflowRunRequest (optional)
+    startWorkflowRunRequest: ...,
+  } satisfies StartWorkflowRunOperationRequest;
 
   try {
     const data = await api.startWorkflowRun(body);
@@ -637,6 +639,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **runId** | `string` |  | [Defaults to `undefined`] |
+| **startWorkflowRunRequest** | [StartWorkflowRunRequest](StartWorkflowRunRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -648,7 +651,7 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: `application/json`
 - **Accept**: `application/json`
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.104.0",
+  "version": "1.105.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/WorkflowRunsApi.ts

@@ -21,6 +21,7 @@ import type {
   PaginatedResponseWorkflowRunResponse,
   SetWorkflowRunApprovalRequest,
   SortDirection,
+  StartWorkflowRunRequest,
   UpdateWorkflowRunRequest,
   WorkflowCallbackResponse,
   WorkflowExecutionState,
@@ -42,6 +43,8 @@ import {
     SetWorkflowRunApprovalRequestToJSON,
     SortDirectionFromJSON,
     SortDirectionToJSON,
+    StartWorkflowRunRequestFromJSON,
+    StartWorkflowRunRequestToJSON,
     UpdateWorkflowRunRequestFromJSON,
     UpdateWorkflowRunRequestToJSON,
     WorkflowCallbackResponseFromJSON,
@@ -102,8 +105,9 @@ export interface SetWorkflowRunApprovalOperationRequest {
     setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
 }
 
-export interface StartWorkflowRunRequest {
+export interface StartWorkflowRunOperationRequest {
     runId: string;
+    startWorkflowRunRequest?: StartWorkflowRunRequest | null;
 }
 
 export interface StopWorkflowRunRequest {
@@ -328,26 +332,28 @@ export interface WorkflowRunsApiInterface {
     /**
      * Creates request options for startWorkflowRun without sending the request
      * @param {string} runId 
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest] 
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
+    startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * @summary Start Workflow Run Handler
      * @param {string} runId 
+     * @param {StartWorkflowRunRequest} [startWorkflowRunRequest] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowRunsApiInterface
      */
-    startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+    startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
 
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+    startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
 
     /**
      * Creates request options for stopWorkflowRun without sending the request
@@ -883,7 +889,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
     /**
      * Creates request options for startWorkflowRun without sending the request
      */
-    async startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts> {
+    async startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['runId'] == null) {
             throw new runtime.RequiredError(
                 'runId',
@@ -895,6 +901,8 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+        headerParameters['Content-Type'] = 'application/json';
+
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
             const tokenString = await token("bearerAuth", []);
@@ -912,14 +920,15 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: StartWorkflowRunRequestToJSON(requestParameters['startWorkflowRunRequest']),
         };
     }
 
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    async startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
+    async startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
         const requestOptions = await this.startWorkflowRunRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
@@ -927,10 +936,10 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
     }
 
     /**
-     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).  The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
      * Start Workflow Run Handler
      */
-    async startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
+    async startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
         const response = await this.startWorkflowRunRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/models/StartWorkflowRunRequest.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.
+ * 
+ * The whole body is optional: an absent body starts the run with just
+ * the localized "Started workflow: X" opening message, exactly as
+ * before. When ``user_message`` is set it is appended to that opening
+ * thread message AND injected into the runner's first user turn, so the
+ * agent acts on it as guidance layered on the workflow instruction.
+ * @export
+ * @interface StartWorkflowRunRequest
+ */
+export interface StartWorkflowRunRequest {
+    /**
+     * Free-text instruction shown in the run thread and passed to the agent as additional guidance on top of the workflow instruction. Optional.
+     * @type {string}
+     * @memberof StartWorkflowRunRequest
+     */
+    userMessage?: string | null;
+}
+export const StartWorkflowRunRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    userMessage: {
+        maxLength: 4000,
+    },
+}
+
+
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+export function instanceOfStartWorkflowRunRequest(value: object): value is StartWorkflowRunRequest {
+    return true;
+}
+
+export function StartWorkflowRunRequestFromJSON(json: any): StartWorkflowRunRequest {
+    return StartWorkflowRunRequestFromJSONTyped(json, false);
+}
+
+export function StartWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWorkflowRunRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
+    };
+}
+
+export function StartWorkflowRunRequestToJSON(json: any): StartWorkflowRunRequest {
+    return StartWorkflowRunRequestToJSONTyped(json, false);
+}
+
+export function StartWorkflowRunRequestToJSONTyped(value?: StartWorkflowRunRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_message': value['userMessage'],
+    };
+}
+

package/src/models/WorkflowRunSnapshot.ts

@@ -66,6 +66,12 @@ export interface WorkflowRunSnapshot {
      * @memberof WorkflowRunSnapshot
      */
     inputs: Array<InputSnapshot>;
+    /**
+     * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    userMessage?: string | null;
 }
 export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {
@@ -82,6 +88,9 @@ export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    userMessage: {
+        maxLength: 4000,
+    },
 }
 
 
@@ -110,6 +119,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'instruction': InstructionSnapshotFromJSON(json['instruction']),
         'inputs': ((json['inputs'] as Array<any>).map(InputSnapshotFromJSON)),
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
     };
 }
 
@@ -128,6 +138,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'instruction': InstructionSnapshotToJSON(value['instruction']),
         'inputs': ((value['inputs'] as Array<any>).map(InputSnapshotToJSON)),
+        'user_message': value['userMessage'],
     };
 }
 

package/src/models/index.ts

@@ -213,6 +213,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SignInRequest';
 export * from './SortDirection';
+export * from './StartWorkflowRunRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';