@knowledge-stack/ksapi 1.149.0 → 1.150.0

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

@@ -379,3 +379,5 @@ __exportStar(require("./XlsxCellAnchorInputOrDocxParagraphAnchorInput"), exports
 __exportStar(require("./XlsxCellAnchorOutput"), exports);
 __exportStar(require("./XlsxCellAnchorOutputOrDocxParagraphAnchorOutput"), exports);
 __exportStar(require("./ZipFileResult"), exports);
+__exportStar(require("./ZipIngestionStatusResponse"), exports);
+__exportStar(require("./ZipMemberStatusResponse"), exports);

package/docs/DocumentVersionMetadata.md

@@ -27,6 +27,7 @@ Name | Type
 `quotaPageCount` | number
 `quotaIdempotencyKey` | string
 `fileMd5` | string
+`idempotencyKey` | string
 
 ## Example
 
@@ -55,6 +56,7 @@ const example = {
   "quotaPageCount": null,
   "quotaIdempotencyKey": null,
   "fileMd5": null,
+  "idempotencyKey": null,
 } satisfies DocumentVersionMetadata
 
 console.log(example)

package/docs/DocumentsApi.md

@@ -322,7 +322,7 @@ example().catch(console.error);
 
 ## ingestDocument
 
-> IngestDocumentResponse ingestDocument(file, pathPartId, name, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, workflowDefinitionId)
+> IngestDocumentResponse ingestDocument(file, pathPartId, name, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, tagIds, idempotencyKey, workflowDefinitionId)
 
 Ingest Document Handler
 
@@ -364,6 +364,10 @@ async function example() {
     pageDpi: 56,
     // string | Workflow run context for assumed agent uploads. (optional)
     workflowRunId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Array<string> | Tag IDs applied to the created document. (optional)
+    tagIds: ...,
+    // string | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. (optional)
+    idempotencyKey: idempotencyKey_example,
     // string | Workflow definition context for assumed agent uploads. (optional)
     workflowDefinitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies IngestDocumentRequest;
@@ -393,6 +397,8 @@ example().catch(console.error);
 | **secondaryTaxonomy** | `ImageTaxonomy` |  | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
 | **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
 | **workflowRunId** | `string` | Workflow run context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
+| **tagIds** | `Array<string>` | Tag IDs applied to the created document. | [Optional] |
+| **idempotencyKey** | `string` | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. | [Optional] [Defaults to `undefined`] |
 | **workflowDefinitionId** | `string` | Workflow definition context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -517,11 +523,11 @@ example().catch(console.error);
 
 ## ingestZip
 
-> IngestZipResponse ingestZip(file, pathPartId, ingestionMode)
+> IngestZipResponse ingestZip(file, pathPartId, ingestionMode, tagIds)
 
 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, &gt;500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with &#x60;&#x60;error&#x60;&#x60; set; other files continue processing.
+Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (&#x60;&#x60;report.zip&#x60;&#x60; -&gt; &#x60;&#x60;report/&#x60;&#x60;), with the ZIP\&#39;s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out &#x60;&#x60;workflow_id&#x60;&#x60; (poll &#x60;&#x60;GET /v1/system-jobs/zip-ingestions/{workflow_id}&#x60;&#x60; for per-member outcomes) plus the artifacts &#x60;&#x60;skipped&#x60;&#x60; during classification.  Whole-archive failures (not a ZIP, zip-bomb, &gt;500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
 
 ### Example
 
@@ -549,6 +555,8 @@ async function example() {
     pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // IngestionMode (optional)
     ingestionMode: ...,
+    // Array<string> | Tag IDs applied to every ingested member document. (optional)
+    tagIds: ...,
   } satisfies IngestZipRequest;
 
   try {
@@ -571,6 +579,7 @@ example().catch(console.error);
 | **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] |
+| **tagIds** | `Array<string>` | Tag IDs applied to every ingested member document. | [Optional] |
 
 ### Return type
 

package/docs/IngestZipResponse.md

@@ -1,17 +1,14 @@
 
 # IngestZipResponse
 
-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.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`files` | [Array<ZipFileResult>](ZipFileResult.md)
-`totalFound` | number
-`succeeded` | number
-`skipped` | number
-`failed` | number
+`workflowId` | string
+`skipped` | [Array<ZipFileResult>](ZipFileResult.md)
 
 ## Example
 
@@ -20,11 +17,8 @@ import type { IngestZipResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "files": null,
-  "totalFound": null,
-  "succeeded": null,
+  "workflowId": null,
   "skipped": null,
-  "failed": null,
 } satisfies IngestZipResponse
 
 console.log(example)

package/docs/SystemJobsApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
 | [**dvWorkflowRerun**](SystemJobsApi.md#dvworkflowrerun) | **POST** /v1/system-jobs/document_versions/{workflow_id} | Dv Workflow Rerun Handler |
 | [**getDvWorkflow**](SystemJobsApi.md#getdvworkflow) | **GET** /v1/system-jobs/document_versions/{workflow_id} | Get Dv Workflow Handler |
 | [**getTemporalWorkflowStatus**](SystemJobsApi.md#gettemporalworkflowstatus) | **GET** /v1/system-jobs/{workflow_id} | Get Temporal Workflow Status Handler |
+| [**getZipIngestionStatus**](SystemJobsApi.md#getzipingestionstatus) | **GET** /v1/system-jobs/zip-ingestions/{workflow_id} | Get Zip Ingestion Status Handler |
 | [**listDvWorkflows**](SystemJobsApi.md#listdvworkflows) | **GET** /v1/system-jobs/document_versions | List Dv Workflows Handler |
 
 
@@ -312,6 +313,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)
 
 
+## getZipIngestionStatus
+
+> ZipIngestionStatusResponse getZipIngestionStatus(workflowId)
+
+Get Zip Ingestion Status Handler
+
+Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemJobsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetZipIngestionStatusRequest } 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 SystemJobsApi(config);
+
+  const body = {
+    // string
+    workflowId: workflowId_example,
+  } satisfies GetZipIngestionStatusRequest;
+
+  try {
+    const data = await api.getZipIngestionStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **workflowId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZipIngestionStatusResponse**](ZipIngestionStatusResponse.md)
+
+### 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 |
+|-------------|-------------|------------------|
+| **200** | 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)
+
+
 ## listDvWorkflows
 
 > PaginatedResponseWorkflowSummaryResponse listDvWorkflows(limit, offset)

package/docs/ZipIngestionStatusResponse.md

@@ -0,0 +1,39 @@
+
+# ZipIngestionStatusResponse
+
+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``).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`temporalStatus` | string
+`files` | [Array<ZipMemberStatusResponse>](ZipMemberStatusResponse.md)
+
+## Example
+
+```typescript
+import type { ZipIngestionStatusResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "temporalStatus": null,
+  "files": null,
+} satisfies ZipIngestionStatusResponse
+
+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 ZipIngestionStatusResponse
+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/ZipMemberStatusResponse.md

@@ -0,0 +1,45 @@
+
+# ZipMemberStatusResponse
+
+One member\'s outcome within a ZIP fan-out (from the workflow query).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zipPath` | string
+`documentId` | string
+`documentVersionId` | string
+`workflowId` | string
+`error` | string
+`skipped` | boolean
+
+## Example
+
+```typescript
+import type { ZipMemberStatusResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "zipPath": null,
+  "documentId": null,
+  "documentVersionId": null,
+  "workflowId": null,
+  "error": null,
+  "skipped": null,
+} satisfies ZipMemberStatusResponse
+
+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 ZipMemberStatusResponse
+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.149.0",
+  "version": "1.150.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentsApi.ts

@@ -94,6 +94,8 @@ export interface IngestDocumentRequest {
     secondaryTaxonomy?: ImageTaxonomy;
     pageDpi?: number;
     workflowRunId?: string | null;
+    tagIds?: Array<string>;
+    idempotencyKey?: string | null;
     workflowDefinitionId?: string | null;
 }
 
@@ -112,6 +114,7 @@ export interface IngestZipRequest {
     file: Blob;
     pathPartId: string;
     ingestionMode?: IngestionMode;
+    tagIds?: Array<string>;
 }
 
 export interface ListDocumentsRequest {
@@ -250,6 +253,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy] 
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
@@ -267,6 +272,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy] 
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -323,17 +330,19 @@ export interface DocumentsApiInterface {
      * @param {Blob} file 
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode] 
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
      */
     ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * @summary Ingest Zip Handler
      * @param {Blob} file 
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode] 
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
@@ -341,7 +350,7 @@ export interface DocumentsApiInterface {
     ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
 
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
@@ -730,6 +739,14 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('workflow_run_id', requestParameters['workflowRunId'] as any);
         }
 
+        if (requestParameters['tagIds'] != null) {
+            formParams.append('tag_ids', requestParameters['tagIds']!.join(runtime.COLLECTION_FORMATS["csv"]));
+        }
+
+        if (requestParameters['idempotencyKey'] != null) {
+            formParams.append('idempotency_key', requestParameters['idempotencyKey'] as any);
+        }
+
         if (requestParameters['workflowDefinitionId'] != null) {
             formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId'] as any);
         }
@@ -931,6 +948,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('ingestion_mode', requestParameters['ingestionMode'] as any);
         }
 
+        if (requestParameters['tagIds'] != null) {
+            formParams.append('tag_ids', requestParameters['tagIds']!.join(runtime.COLLECTION_FORMATS["csv"]));
+        }
+
 
         let urlPath = `/v1/documents/ingest-zip`;
 
@@ -944,7 +965,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     async ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>> {
@@ -955,7 +976,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     async ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse> {