@knowledge-stack/ksapi 1.146.0 → 1.147.1

package/dist/esm/models/ZipFileResult.js

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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 ZipFileResultPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipFileResult interface.
+ */
+export function instanceOfZipFileResult(value) {
+    if (!('zipPath' in value) || value['zipPath'] === undefined)
+        return false;
+    return true;
+}
+export function ZipFileResultFromJSON(json) {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+export function ZipFileResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'zipPath': json['zip_path'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'workflowId': json['workflow_id'] == null ? undefined : json['workflow_id'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+export function ZipFileResultToJSON(json) {
+    return ZipFileResultToJSONTyped(json, false);
+}
+export function ZipFileResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'zip_path': value['zipPath'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'workflow_id': value['workflowId'],
+        'skipped': value['skipped'],
+        'error': value['error'],
+    };
+}

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

@@ -139,6 +139,7 @@ export * from './IdpType';
 export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
+export * from './IngestZipResponse';
 export * from './IngestionMode';
 export * from './Input';
 export * from './InputOrigin';
@@ -357,3 +358,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';

package/dist/esm/models/index.js

@@ -141,6 +141,7 @@ export * from './IdpType';
 export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
+export * from './IngestZipResponse';
 export * from './IngestionMode';
 export * from './Input';
 export * from './InputOrigin';
@@ -359,3 +360,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';

package/dist/models/IngestZipResponse.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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 type { ZipFileResult } from './ZipFileResult';
+/**
+ * Aggregate response from a ZIP ingestion batch.
+ * @export
+ * @interface IngestZipResponse
+ */
+export interface IngestZipResponse {
+    /**
+     *
+     * @type {Array<ZipFileResult>}
+     * @memberof IngestZipResponse
+     */
+    files: Array<ZipFileResult>;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    totalFound: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    succeeded: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    skipped: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    failed: number;
+}
+export declare const IngestZipResponsePropertyValidationAttributesMap: {
+    [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 IngestZipResponse interface.
+ */
+export declare function instanceOfIngestZipResponse(value: object): value is IngestZipResponse;
+export declare function IngestZipResponseFromJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestZipResponse;
+export declare function IngestZipResponseToJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseToJSONTyped(value?: IngestZipResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IngestZipResponse.js

@@ -0,0 +1,69 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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.IngestZipResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfIngestZipResponse = instanceOfIngestZipResponse;
+exports.IngestZipResponseFromJSON = IngestZipResponseFromJSON;
+exports.IngestZipResponseFromJSONTyped = IngestZipResponseFromJSONTyped;
+exports.IngestZipResponseToJSON = IngestZipResponseToJSON;
+exports.IngestZipResponseToJSONTyped = IngestZipResponseToJSONTyped;
+const ZipFileResult_1 = require("./ZipFileResult");
+exports.IngestZipResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the IngestZipResponse interface.
+ */
+function instanceOfIngestZipResponse(value) {
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    if (!('totalFound' in value) || value['totalFound'] === undefined)
+        return false;
+    if (!('succeeded' in value) || value['succeeded'] === undefined)
+        return false;
+    if (!('skipped' in value) || value['skipped'] === undefined)
+        return false;
+    if (!('failed' in value) || value['failed'] === undefined)
+        return false;
+    return true;
+}
+function IngestZipResponseFromJSON(json) {
+    return IngestZipResponseFromJSONTyped(json, false);
+}
+function IngestZipResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'files': (json['files'].map(ZipFileResult_1.ZipFileResultFromJSON)),
+        'totalFound': json['total_found'],
+        'succeeded': json['succeeded'],
+        'skipped': json['skipped'],
+        'failed': json['failed'],
+    };
+}
+function IngestZipResponseToJSON(json) {
+    return IngestZipResponseToJSONTyped(json, false);
+}
+function IngestZipResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'files': (value['files'].map(ZipFileResult_1.ZipFileResultToJSON)),
+        'total_found': value['totalFound'],
+        'succeeded': value['succeeded'],
+        'skipped': value['skipped'],
+        'failed': value['failed'],
+    };
+}

package/dist/models/ZipFileResult.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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.
+ */
+/**
+ * Per-file outcome from a ZIP ingestion batch.
+ * @export
+ * @interface ZipFileResult
+ */
+export interface ZipFileResult {
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    zipPath: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentVersionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    workflowId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ZipFileResult
+     */
+    skipped?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    error?: string | null;
+}
+export declare const ZipFileResultPropertyValidationAttributesMap: {
+    [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 ZipFileResult interface.
+ */
+export declare function instanceOfZipFileResult(value: object): value is ZipFileResult;
+export declare function ZipFileResultFromJSON(json: any): ZipFileResult;
+export declare function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult;
+export declare function ZipFileResultToJSON(json: any): ZipFileResult;
+export declare function ZipFileResultToJSONTyped(value?: ZipFileResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZipFileResult.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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.ZipFileResultPropertyValidationAttributesMap = void 0;
+exports.instanceOfZipFileResult = instanceOfZipFileResult;
+exports.ZipFileResultFromJSON = ZipFileResultFromJSON;
+exports.ZipFileResultFromJSONTyped = ZipFileResultFromJSONTyped;
+exports.ZipFileResultToJSON = ZipFileResultToJSON;
+exports.ZipFileResultToJSONTyped = ZipFileResultToJSONTyped;
+exports.ZipFileResultPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipFileResult interface.
+ */
+function instanceOfZipFileResult(value) {
+    if (!('zipPath' in value) || value['zipPath'] === undefined)
+        return false;
+    return true;
+}
+function ZipFileResultFromJSON(json) {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+function ZipFileResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'zipPath': json['zip_path'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'workflowId': json['workflow_id'] == null ? undefined : json['workflow_id'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+function ZipFileResultToJSON(json) {
+    return ZipFileResultToJSONTyped(json, false);
+}
+function ZipFileResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'zip_path': value['zipPath'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'workflow_id': value['workflowId'],
+        'skipped': value['skipped'],
+        'error': value['error'],
+    };
+}

package/dist/models/index.d.ts

@@ -139,6 +139,7 @@ export * from './IdpType';
 export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
+export * from './IngestZipResponse';
 export * from './IngestionMode';
 export * from './Input';
 export * from './InputOrigin';
@@ -357,3 +358,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';

package/dist/models/index.js

@@ -157,6 +157,7 @@ __exportStar(require("./IdpType"), exports);
 __exportStar(require("./ImageTaxonomy"), exports);
 __exportStar(require("./InformationStatistics"), exports);
 __exportStar(require("./IngestDocumentResponse"), exports);
+__exportStar(require("./IngestZipResponse"), exports);
 __exportStar(require("./IngestionMode"), exports);
 __exportStar(require("./Input"), exports);
 __exportStar(require("./InputOrigin"), exports);
@@ -375,3 +376,4 @@ __exportStar(require("./XlsxCellAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorInputOrDocxParagraphAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorOutput"), exports);
 __exportStar(require("./XlsxCellAnchorOutputOrDocxParagraphAnchorOutput"), exports);
+__exportStar(require("./ZipFileResult"), exports);

package/docs/DocumentsApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8000*
 | [**getDocument**](DocumentsApi.md#getdocument) | **GET** /v1/documents/{document_id} | Get Document Handler |
 | [**ingestDocument**](DocumentsApi.md#ingestdocument) | **POST** /v1/documents/ingest | Ingest Document Handler |
 | [**ingestDocumentVersion**](DocumentsApi.md#ingestdocumentversion) | **POST** /v1/documents/{document_id}/ingest | Ingest Document Version Handler |
+| [**ingestZip**](DocumentsApi.md#ingestzip) | **POST** /v1/documents/ingest-zip | Ingest Zip Handler |
 | [**listDocuments**](DocumentsApi.md#listdocuments) | **GET** /v1/documents | List Documents Handler |
 | [**updateDocument**](DocumentsApi.md#updatedocumentoperation) | **PATCH** /v1/documents/{document_id} | Update Document Handler |
 
@@ -514,6 +515,87 @@ 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)
 
 
+## ingestZip
+
+> IngestZipResponse ingestZip(file, pathPartId, ingestionMode)
+
+Ingest Zip Handler
+
+Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@knowledge-stack/ksapi';
+import type { IngestZipRequest } 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 DocumentsApi(config);
+
+  const body = {
+    // Blob
+    file: BINARY_DATA_HERE,
+    // string | Parent path part ID (must be a FOLDER type)
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // IngestionMode (optional)
+    ingestionMode: ...,
+  } satisfies IngestZipRequest;
+
+  try {
+    const data = await api.ingestZip(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+| **pathPartId** | `string` | Parent path part ID (must be a FOLDER type) | [Defaults to `undefined`] |
+| **ingestionMode** | `IngestionMode` |  | [Optional] [Defaults to `undefined`] [Enum: high_accuracy, standard, single_chunk] |
+
+### Return type
+
+[**IngestZipResponse**](IngestZipResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | 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)
+
+
 ## listDocuments
 
 > PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, sortDir, ownerId, documentType, withTags, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)

package/docs/IngestZipResponse.md

@@ -0,0 +1,43 @@
+
+# IngestZipResponse
+
+Aggregate response from a ZIP ingestion batch.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`files` | [Array<ZipFileResult>](ZipFileResult.md)
+`totalFound` | number
+`succeeded` | number
+`skipped` | number
+`failed` | number
+
+## Example
+
+```typescript
+import type { IngestZipResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "files": null,
+  "totalFound": null,
+  "succeeded": null,
+  "skipped": null,
+  "failed": null,
+} satisfies IngestZipResponse
+
+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 IngestZipResponse
+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/ZipFileResult.md

@@ -0,0 +1,45 @@
+
+# ZipFileResult
+
+Per-file outcome from a ZIP ingestion batch.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zipPath` | string
+`documentId` | string
+`documentVersionId` | string
+`workflowId` | string
+`skipped` | boolean
+`error` | string
+
+## Example
+
+```typescript
+import type { ZipFileResult } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "zipPath": null,
+  "documentId": null,
+  "documentVersionId": null,
+  "workflowId": null,
+  "skipped": null,
+  "error": null,
+} satisfies ZipFileResult
+
+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 ZipFileResult
+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/package.json

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