@knowledge-stack/ksapi 1.149.1 → 1.150.0

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

@@ -11,41 +11,28 @@
  */
 import type { ZipFileResult } from './ZipFileResult';
 /**
- * Aggregate response from a ZIP ingestion batch.
+ * Response from dispatching a ZIP archive to async ingestion.
+ *
+ * ``workflow_id`` is the fan-out workflow to poll at
+ * ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes;
+ * it is None when the archive held no ingestible members. ``skipped`` are the
+ * artifact/error entries resolved synchronously during classification.
  * @export
  * @interface IngestZipResponse
  */
 export interface IngestZipResponse {
     /**
      *
-     * @type {Array<ZipFileResult>}
-     * @memberof IngestZipResponse
-     */
-    files: Array<ZipFileResult>;
-    /**
-     *
-     * @type {number}
+     * @type {string}
      * @memberof IngestZipResponse
      */
-    totalFound: number;
+    workflowId: string | null;
     /**
      *
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    succeeded: number;
-    /**
-     *
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    skipped: number;
-    /**
-     *
-     * @type {number}
+     * @type {Array<ZipFileResult>}
      * @memberof IngestZipResponse
      */
-    failed: number;
+    skipped: Array<ZipFileResult>;
 }
 export declare const IngestZipResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/IngestZipResponse.js

@@ -17,16 +17,10 @@ export const IngestZipResponsePropertyValidationAttributesMap = {};
  * Check if a given object implements the IngestZipResponse interface.
  */
 export 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)
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
         return false;
     if (!('skipped' in value) || value['skipped'] === undefined)
         return false;
-    if (!('failed' in value) || value['failed'] === undefined)
-        return false;
     return true;
 }
 export function IngestZipResponseFromJSON(json) {
@@ -37,11 +31,8 @@ export function IngestZipResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'files': (json['files'].map(ZipFileResultFromJSON)),
-        'totalFound': json['total_found'],
-        'succeeded': json['succeeded'],
-        'skipped': json['skipped'],
-        'failed': json['failed'],
+        'workflowId': json['workflow_id'],
+        'skipped': (json['skipped'].map(ZipFileResultFromJSON)),
     };
 }
 export function IngestZipResponseToJSON(json) {
@@ -52,10 +43,7 @@ export function IngestZipResponseToJSONTyped(value, ignoreDiscriminator = false)
         return value;
     }
     return {
-        'files': (value['files'].map(ZipFileResultToJSON)),
-        'total_found': value['totalFound'],
-        'succeeded': value['succeeded'],
-        'skipped': value['skipped'],
-        'failed': value['failed'],
+        'workflow_id': value['workflowId'],
+        'skipped': (value['skipped'].map(ZipFileResultToJSON)),
     };
 }

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { ZipMemberStatusResponse } from './ZipMemberStatusResponse';
+/**
+ * Status of a ZIP fan-out: live Temporal state + per-member outcomes.
+ *
+ * ``files`` reflects progress so far — members that have been dispatched
+ * (``workflow_id`` set), failed to dispatch (``error`` set), or were skipped as
+ * artifacts. Poll until ``temporal_status`` is terminal (e.g. ``COMPLETED``).
+ * @export
+ * @interface ZipIngestionStatusResponse
+ */
+export interface ZipIngestionStatusResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    workflowId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    temporalStatus: string;
+    /**
+     *
+     * @type {Array<ZipMemberStatusResponse>}
+     * @memberof ZipIngestionStatusResponse
+     */
+    files: Array<ZipMemberStatusResponse>;
+}
+export declare const ZipIngestionStatusResponsePropertyValidationAttributesMap: {
+    [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 ZipIngestionStatusResponse interface.
+ */
+export declare function instanceOfZipIngestionStatusResponse(value: object): value is ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseFromJSON(json: any): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseToJSON(json: any): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseToJSONTyped(value?: ZipIngestionStatusResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZipIngestionStatusResponse.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+import { ZipMemberStatusResponseFromJSON, ZipMemberStatusResponseToJSON, } from './ZipMemberStatusResponse';
+export const ZipIngestionStatusResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipIngestionStatusResponse interface.
+ */
+export function instanceOfZipIngestionStatusResponse(value) {
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    if (!('temporalStatus' in value) || value['temporalStatus'] === undefined)
+        return false;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    return true;
+}
+export function ZipIngestionStatusResponseFromJSON(json) {
+    return ZipIngestionStatusResponseFromJSONTyped(json, false);
+}
+export function ZipIngestionStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'workflowId': json['workflow_id'],
+        'temporalStatus': json['temporal_status'],
+        'files': (json['files'].map(ZipMemberStatusResponseFromJSON)),
+    };
+}
+export function ZipIngestionStatusResponseToJSON(json) {
+    return ZipIngestionStatusResponseToJSONTyped(json, false);
+}
+export function ZipIngestionStatusResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'workflow_id': value['workflowId'],
+        'temporal_status': value['temporalStatus'],
+        'files': (value['files'].map(ZipMemberStatusResponseToJSON)),
+    };
+}

package/dist/esm/models/ZipMemberStatusResponse.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.
+ */
+/**
+ * One member's outcome within a ZIP fan-out (from the workflow query).
+ * @export
+ * @interface ZipMemberStatusResponse
+ */
+export interface ZipMemberStatusResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    zipPath: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    documentId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    documentVersionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    workflowId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    error?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ZipMemberStatusResponse
+     */
+    skipped?: boolean;
+}
+export declare const ZipMemberStatusResponsePropertyValidationAttributesMap: {
+    [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 ZipMemberStatusResponse interface.
+ */
+export declare function instanceOfZipMemberStatusResponse(value: object): value is ZipMemberStatusResponse;
+export declare function ZipMemberStatusResponseFromJSON(json: any): ZipMemberStatusResponse;
+export declare function ZipMemberStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipMemberStatusResponse;
+export declare function ZipMemberStatusResponseToJSON(json: any): ZipMemberStatusResponse;
+export declare function ZipMemberStatusResponseToJSONTyped(value?: ZipMemberStatusResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZipMemberStatusResponse.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 ZipMemberStatusResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipMemberStatusResponse interface.
+ */
+export function instanceOfZipMemberStatusResponse(value) {
+    if (!('zipPath' in value) || value['zipPath'] === undefined)
+        return false;
+    return true;
+}
+export function ZipMemberStatusResponseFromJSON(json) {
+    return ZipMemberStatusResponseFromJSONTyped(json, false);
+}
+export function ZipMemberStatusResponseFromJSONTyped(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'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+    };
+}
+export function ZipMemberStatusResponseToJSON(json) {
+    return ZipMemberStatusResponseToJSONTyped(json, false);
+}
+export function ZipMemberStatusResponseToJSONTyped(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'],
+        'error': value['error'],
+        'skipped': value['skipped'],
+    };
+}

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

@@ -361,3 +361,5 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './ZipFileResult';
+export * from './ZipIngestionStatusResponse';
+export * from './ZipMemberStatusResponse';

package/dist/esm/models/index.js

@@ -363,3 +363,5 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './ZipFileResult';
+export * from './ZipIngestionStatusResponse';
+export * from './ZipMemberStatusResponse';

package/dist/models/DocumentVersionMetadata.d.ts

@@ -151,6 +151,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     fileMd5?: string;
+    /**
+     * Opt-in create key. A repeat ingest with the same key at the same (parent, name) replays this document instead of colliding — makes a ZIP fan-out member retry idempotent.
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    idempotencyKey?: string | null;
 }
 export declare const DocumentVersionMetadataPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/DocumentVersionMetadata.js

@@ -57,6 +57,7 @@ function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
+        'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
     };
 }
 function DocumentVersionMetadataToJSON(json) {
@@ -87,5 +88,6 @@ function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator = false)
         'quota_page_count': value['quotaPageCount'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
+        'idempotency_key': value['idempotencyKey'],
     };
 }

package/dist/models/IngestZipResponse.d.ts

@@ -11,41 +11,28 @@
  */
 import type { ZipFileResult } from './ZipFileResult';
 /**
- * Aggregate response from a ZIP ingestion batch.
+ * Response from dispatching a ZIP archive to async ingestion.
+ *
+ * ``workflow_id`` is the fan-out workflow to poll at
+ * ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes;
+ * it is None when the archive held no ingestible members. ``skipped`` are the
+ * artifact/error entries resolved synchronously during classification.
  * @export
  * @interface IngestZipResponse
  */
 export interface IngestZipResponse {
     /**
      *
-     * @type {Array<ZipFileResult>}
-     * @memberof IngestZipResponse
-     */
-    files: Array<ZipFileResult>;
-    /**
-     *
-     * @type {number}
+     * @type {string}
      * @memberof IngestZipResponse
      */
-    totalFound: number;
+    workflowId: string | null;
     /**
      *
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    succeeded: number;
-    /**
-     *
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    skipped: number;
-    /**
-     *
-     * @type {number}
+     * @type {Array<ZipFileResult>}
      * @memberof IngestZipResponse
      */
-    failed: number;
+    skipped: Array<ZipFileResult>;
 }
 export declare const IngestZipResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/IngestZipResponse.js

@@ -25,16 +25,10 @@ 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)
+    if (!('workflowId' in value) || value['workflowId'] === 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) {
@@ -45,11 +39,8 @@ function IngestZipResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'files': (json['files'].map(ZipFileResult_1.ZipFileResultFromJSON)),
-        'totalFound': json['total_found'],
-        'succeeded': json['succeeded'],
-        'skipped': json['skipped'],
-        'failed': json['failed'],
+        'workflowId': json['workflow_id'],
+        'skipped': (json['skipped'].map(ZipFileResult_1.ZipFileResultFromJSON)),
     };
 }
 function IngestZipResponseToJSON(json) {
@@ -60,10 +51,7 @@ function IngestZipResponseToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
-        'files': (value['files'].map(ZipFileResult_1.ZipFileResultToJSON)),
-        'total_found': value['totalFound'],
-        'succeeded': value['succeeded'],
-        'skipped': value['skipped'],
-        'failed': value['failed'],
+        'workflow_id': value['workflowId'],
+        'skipped': (value['skipped'].map(ZipFileResult_1.ZipFileResultToJSON)),
     };
 }

package/dist/models/ZipIngestionStatusResponse.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { ZipMemberStatusResponse } from './ZipMemberStatusResponse';
+/**
+ * Status of a ZIP fan-out: live Temporal state + per-member outcomes.
+ *
+ * ``files`` reflects progress so far — members that have been dispatched
+ * (``workflow_id`` set), failed to dispatch (``error`` set), or were skipped as
+ * artifacts. Poll until ``temporal_status`` is terminal (e.g. ``COMPLETED``).
+ * @export
+ * @interface ZipIngestionStatusResponse
+ */
+export interface ZipIngestionStatusResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    workflowId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    temporalStatus: string;
+    /**
+     *
+     * @type {Array<ZipMemberStatusResponse>}
+     * @memberof ZipIngestionStatusResponse
+     */
+    files: Array<ZipMemberStatusResponse>;
+}
+export declare const ZipIngestionStatusResponsePropertyValidationAttributesMap: {
+    [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 ZipIngestionStatusResponse interface.
+ */
+export declare function instanceOfZipIngestionStatusResponse(value: object): value is ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseFromJSON(json: any): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseToJSON(json: any): ZipIngestionStatusResponse;
+export declare function ZipIngestionStatusResponseToJSONTyped(value?: ZipIngestionStatusResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZipIngestionStatusResponse.js

@@ -0,0 +1,61 @@
+"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.ZipIngestionStatusResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfZipIngestionStatusResponse = instanceOfZipIngestionStatusResponse;
+exports.ZipIngestionStatusResponseFromJSON = ZipIngestionStatusResponseFromJSON;
+exports.ZipIngestionStatusResponseFromJSONTyped = ZipIngestionStatusResponseFromJSONTyped;
+exports.ZipIngestionStatusResponseToJSON = ZipIngestionStatusResponseToJSON;
+exports.ZipIngestionStatusResponseToJSONTyped = ZipIngestionStatusResponseToJSONTyped;
+const ZipMemberStatusResponse_1 = require("./ZipMemberStatusResponse");
+exports.ZipIngestionStatusResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipIngestionStatusResponse interface.
+ */
+function instanceOfZipIngestionStatusResponse(value) {
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    if (!('temporalStatus' in value) || value['temporalStatus'] === undefined)
+        return false;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    return true;
+}
+function ZipIngestionStatusResponseFromJSON(json) {
+    return ZipIngestionStatusResponseFromJSONTyped(json, false);
+}
+function ZipIngestionStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'workflowId': json['workflow_id'],
+        'temporalStatus': json['temporal_status'],
+        'files': (json['files'].map(ZipMemberStatusResponse_1.ZipMemberStatusResponseFromJSON)),
+    };
+}
+function ZipIngestionStatusResponseToJSON(json) {
+    return ZipIngestionStatusResponseToJSONTyped(json, false);
+}
+function ZipIngestionStatusResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'workflow_id': value['workflowId'],
+        'temporal_status': value['temporalStatus'],
+        'files': (value['files'].map(ZipMemberStatusResponse_1.ZipMemberStatusResponseToJSON)),
+    };
+}