@knowledge-stack/ksapi 1.103.3 → 1.105.0

package/dist/models/DataSourceResponse.js

@@ -19,6 +19,7 @@ exports.DataSourceResponseFromJSON = DataSourceResponseFromJSON;
 exports.DataSourceResponseFromJSONTyped = DataSourceResponseFromJSONTyped;
 exports.DataSourceResponseToJSON = DataSourceResponseToJSON;
 exports.DataSourceResponseToJSONTyped = DataSourceResponseToJSONTyped;
+const ItemPermissions_1 = require("./ItemPermissions");
 const PathPartApprovalState_1 = require("./PathPartApprovalState");
 const UserInfo_1 = require("./UserInfo");
 const DataSourceEngine_1 = require("./DataSourceEngine");
@@ -49,6 +50,8 @@ function instanceOfDataSourceResponse(value) {
         return false;
     if (!('approvalState' in value) || value['approvalState'] === undefined)
         return false;
+    if (!('permissions' in value) || value['permissions'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -73,6 +76,7 @@ function DataSourceResponseFromJSONTyped(json, ignoreDiscriminator) {
         'engine': (0, DataSourceEngine_1.DataSourceEngineFromJSON)(json['engine']),
         'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
         'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
+        'permissions': (0, ItemPermissions_1.ItemPermissionsFromJSON)(json['permissions']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -95,6 +99,7 @@ function DataSourceResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'engine': (0, DataSourceEngine_1.DataSourceEngineToJSON)(value['engine']),
         'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
         'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
+        'permissions': (0, ItemPermissions_1.ItemPermissionsToJSON)(value['permissions']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/DataSourceTableResponse.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ItemPermissions } from './ItemPermissions';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 /**
  * Modeled-table response; a discriminated-union variant for listings.
@@ -90,6 +91,12 @@ export interface DataSourceTableResponse {
      * @memberof DataSourceTableResponse
      */
     approvalState: PathPartApprovalState;
+    /**
+     *
+     * @type {ItemPermissions}
+     * @memberof DataSourceTableResponse
+     */
+    permissions: ItemPermissions;
     /**
      *
      * @type {Date}

package/dist/models/DataSourceTableResponse.js

@@ -19,6 +19,7 @@ exports.DataSourceTableResponseFromJSON = DataSourceTableResponseFromJSON;
 exports.DataSourceTableResponseFromJSONTyped = DataSourceTableResponseFromJSONTyped;
 exports.DataSourceTableResponseToJSON = DataSourceTableResponseToJSON;
 exports.DataSourceTableResponseToJSONTyped = DataSourceTableResponseToJSONTyped;
+const ItemPermissions_1 = require("./ItemPermissions");
 const PathPartApprovalState_1 = require("./PathPartApprovalState");
 /**
  * @export
@@ -53,6 +54,8 @@ function instanceOfDataSourceTableResponse(value) {
         return false;
     if (!('approvalState' in value) || value['approvalState'] === undefined)
         return false;
+    if (!('permissions' in value) || value['permissions'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -79,6 +82,7 @@ function DataSourceTableResponseFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'],
         'columnConfig': json['column_config'],
         'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
+        'permissions': (0, ItemPermissions_1.ItemPermissionsFromJSON)(json['permissions']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -103,6 +107,7 @@ function DataSourceTableResponseToJSONTyped(value, ignoreDiscriminator = false)
         'description': value['description'],
         'column_config': value['columnConfig'],
         'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
+        'permissions': (0, ItemPermissions_1.ItemPermissionsToJSON)(value['permissions']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/SearchablePartType.d.ts

@@ -17,6 +17,7 @@ export declare const SearchablePartType: {
     readonly Folder: "FOLDER";
     readonly Document: "DOCUMENT";
     readonly DataSource: "DATA_SOURCE";
+    readonly ApiConnection: "API_CONNECTION";
 };
 export type SearchablePartType = typeof SearchablePartType[keyof typeof SearchablePartType];
 export declare function instanceOfSearchablePartType(value: any): boolean;

package/dist/models/SearchablePartType.js

@@ -26,7 +26,8 @@ exports.SearchablePartTypeToJSONTyped = SearchablePartTypeToJSONTyped;
 exports.SearchablePartType = {
     Folder: 'FOLDER',
     Document: 'DOCUMENT',
-    DataSource: 'DATA_SOURCE'
+    DataSource: 'DATA_SOURCE',
+    ApiConnection: 'API_CONNECTION'
 };
 function instanceOfSearchablePartType(value) {
     for (const key in exports.SearchablePartType) {

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/ApiConnectionsApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8000*
 |------------- | ------------- | -------------|
 | [**acceptApiConnectionDisclaimer**](ApiConnectionsApi.md#acceptapiconnectiondisclaimer) | **POST** /v1/api-connections/{connection_id}/disclaimer | Accept Api Connection Disclaimer Handler |
 | [**createApiConnection**](ApiConnectionsApi.md#createapiconnectionoperation) | **POST** /v1/api-connections | Create Api Connection Handler |
+| [**deleteApiConnection**](ApiConnectionsApi.md#deleteapiconnection) | **DELETE** /v1/api-connections/{connection_id} | Delete Api Connection Handler |
 | [**executeApiConnectionRequest**](ApiConnectionsApi.md#executeapiconnectionrequest) | **POST** /v1/api-connections/{connection_id}/request | Execute Api Connection Request Handler |
 | [**getApiConnection**](ApiConnectionsApi.md#getapiconnection) | **GET** /v1/api-connections/{connection_id} | Get Api Connection Handler |
 | [**updateApiConnection**](ApiConnectionsApi.md#updateapiconnectionoperation) | **PATCH** /v1/api-connections/{connection_id} | Update Api Connection Handler |
@@ -165,6 +166,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteApiConnection
+
+> deleteApiConnection(connectionId)
+
+Delete Api Connection Handler
+
+Move a connection to trash (Admin/Owner).  Soft-delete via the path_part subtree, mirroring create/update authz. A connection holds no Qdrant vectors, so there is no trash-sync workflow.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteApiConnectionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiConnectionsApi(config);
+
+  const body = {
+    // string
+    connectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteApiConnectionRequest;
+
+  try {
+    const data = await api.deleteApiConnection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **connectionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## executeApiConnectionRequest
 
 > ApiConnectionRequestResponse executeApiConnectionRequest(connectionId, apiConnectionRequestRequest)

package/docs/DataSourceResponse.md

@@ -17,6 +17,7 @@ Name | Type
 `engine` | [DataSourceEngine](DataSourceEngine.md)
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `owner` | [UserInfo](UserInfo.md)
+`permissions` | [ItemPermissions](ItemPermissions.md)
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -37,6 +38,7 @@ const example = {
   "engine": null,
   "approvalState": null,
   "owner": null,
+  "permissions": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies DataSourceResponse

package/docs/DataSourceTableResponse.md

@@ -19,6 +19,7 @@ Name | Type
 `description` | string
 `columnConfig` | Array<{ [key: string]: any; }>
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+`permissions` | [ItemPermissions](ItemPermissions.md)
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -41,6 +42,7 @@ const example = {
   "description": null,
   "columnConfig": null,
   "approvalState": null,
+  "permissions": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies DataSourceTableResponse

package/docs/DataSourcesApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost:8000*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**createDataSource**](DataSourcesApi.md#createdatasourceoperation) | **POST** /v1/data-sources | Create Data Source Handler |
+| [**deleteDataSource**](DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler |
 | [**getDataSource**](DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler |
 | [**getDataSourceCatalog**](DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler |
 | [**modelDataSourceTable**](DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler |
@@ -89,6 +90,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteDataSource
+
+> deleteDataSource(dataSourceId)
+
+Delete Data Source Handler
+
+Move a connector and its modeled tables to trash.  Soft-delete via the path_part subtree (the tables are children, so they trash with it). Connectors carry no Qdrant vectors, so there is no trash-sync workflow.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataSourcesApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteDataSourceRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DataSourcesApi(config);
+
+  const body = {
+    // string
+    dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteDataSourceRequest;
+
+  try {
+    const data = await api.deleteDataSource(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataSourceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getDataSource
 
 > DataSourceDetailResponse getDataSource(dataSourceId)

package/docs/FoldersApi.md

@@ -520,7 +520,7 @@ example().catch(console.error);
 
 Search Items Handler
 
-Search for folders, documents, and data-source connectors by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+Search for folders, documents, and connectors by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
 
 ### Example
 
@@ -546,7 +546,7 @@ async function example() {
     nameLike: nameLike_example,
     // SearchSortOrder | Sort order for results (default: NAME) (optional)
     sortOrder: ...,
-    // SearchablePartType | Filter by item type (default: both folders and documents) (optional)
+    // SearchablePartType | Filter by item type (default: all searchable types) (optional)
     partType: ...,
     // boolean | Include tags in the response (default: false) (optional)
     withTags: true,
@@ -577,7 +577,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **nameLike** | `string` | Case-insensitive partial name search | [Defaults to `undefined`] |
 | **sortOrder** | `SearchSortOrder` | Sort order for results (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, UPDATED_AT, CREATED_AT] |
-| **partType** | `SearchablePartType` | Filter by item type (default: both folders and documents) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DATA_SOURCE] |
+| **partType** | `SearchablePartType` | Filter by item type (default: all searchable types) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DATA_SOURCE, API_CONNECTION] |
 | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
 | **parentPathPartId** | `string` | Scope search to descendants of this folder\'s path part | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |

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.103.3",
+  "version": "1.105.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {