@retab/node 1.0.81 → 1.0.83

package/dist/api/documents/client.d.ts

@@ -69,6 +69,7 @@ export default class APIDocuments extends CompositionClient {
      *   - document: MIMEData object, file path, Buffer, or Readable stream
      *   - categories: Array of categories with 'name' and 'description'
      *   - model: LLM model for inference (e.g., "retab-small")
+     *   - first_n_pages: (optional) Only use the first N pages for classification. Useful for large documents.
      * @param options - Optional request options
      * @returns ClassifyResponse containing result with reasoning and classification
      *
@@ -81,7 +82,8 @@ export default class APIDocuments extends CompositionClient {
      *         { name: "invoice", description: "Invoice documents with billing information" },
      *         { name: "receipt", description: "Receipt documents for payments" },
      *         { name: "contract", description: "Legal contract documents" },
-     *     ]
+     *     ],
+     *     first_n_pages: 3  // Optional: only use first 3 pages
      * });
      * console.log(`Classification: ${response.result.classification}`);
      * console.log(`Reasoning: ${response.result.reasoning}`);

package/dist/api/documents/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,MAAM,gBAAgB,CAAC;AACrjB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,MAAM,gBAAgB,CAAC;AACrjB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}

package/dist/api/documents/client.js

@@ -128,6 +128,7 @@ export default class APIDocuments extends CompositionClient {
      *   - document: MIMEData object, file path, Buffer, or Readable stream
      *   - categories: Array of categories with 'name' and 'description'
      *   - model: LLM model for inference (e.g., "retab-small")
+     *   - first_n_pages: (optional) Only use the first N pages for classification. Useful for large documents.
      * @param options - Optional request options
      * @returns ClassifyResponse containing result with reasoning and classification
      *
@@ -140,7 +141,8 @@ export default class APIDocuments extends CompositionClient {
      *         { name: "invoice", description: "Invoice documents with billing information" },
      *         { name: "receipt", description: "Receipt documents for payments" },
      *         { name: "contract", description: "Legal contract documents" },
-     *     ]
+     *     ],
+     *     first_n_pages: 3  // Optional: only use first 3 pages
      * });
      * console.log(`Classification: ${response.result.classification}`);
      * console.log(`Reasoning: ${response.result.reasoning}`);

package/dist/api/edit/templates/client.d.ts

@@ -111,15 +111,17 @@ export default class APIEditTemplates extends CompositionClient {
      *   - template_id: The template ID to use for filling
      *   - instructions: Instructions describing how to fill the form fields
      *   - model: LLM model for inference (default: "retab-small")
+     *   - color: Hex color code for filled text (default: "#000080")
      * @param options - Optional request options
      * @returns EditResponse containing:
      *   - form_data: List of form fields with filled values
      *   - filled_document: The filled PDF document as MIMEData
      */
-    fill({ template_id, instructions, model, }: {
+    fill({ template_id, instructions, model, color, }: {
         template_id: string;
         instructions: string;
         model?: string;
+        color?: string;
     }, options?: RequestOptions): Promise<EditResponse>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/edit/templates/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/edit/templates/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAEH,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EAGvB,aAAa,EAEb,YAAY,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,YAAY,EAEZ,SAAS,EACZ,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,iBAAiB;gBAC/C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;OAMG;IACG,IAAI,CACN,EACI,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,QAAQ,EACR,SAAS,EACT,kBAA0B,EAC1B,OAAsB,GACzB,GAAE;QACC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KACf,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAyBzB;;;;;;OAMG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS/E;;;;;;;;;OASG;IACG,MAAM,CACR,EACI,IAAI,EACJ,QAAQ,EACR,WAAW,GACd,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,aAAa,CAAC;QACxB,WAAW,EAAE,SAAS,EAAE,CAAC;KAC5B,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;OASG;IACG,MAAM,CACR,WAAW,EAAE,MAAM,EACnB,EACI,IAAI,EACJ,WAAW,GACd,GAAE;QACC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC;KACxB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;OAKG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E;;;;;;;;OAQG;IACG,SAAS,CACX,WAAW,EAAE,MAAM,EACnB,EAAE,IAAI,EAAE,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,EAChC,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CACN,EACI,WAAW,EACX,YAAY,EACZ,KAAqB,GACxB,EAAE;QACC,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;CAc3B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/edit/templates/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAEH,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EAGvB,aAAa,EAEb,YAAY,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,YAAY,EAEZ,SAAS,EACZ,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,iBAAiB;gBAC/C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;OAMG;IACG,IAAI,CACN,EACI,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,QAAQ,EACR,SAAS,EACT,kBAA0B,EAC1B,OAAsB,GACzB,GAAE;QACC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KACf,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAyBzB;;;;;;OAMG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS/E;;;;;;;;;OASG;IACG,MAAM,CACR,EACI,IAAI,EACJ,QAAQ,EACR,WAAW,GACd,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,aAAa,CAAC;QACxB,WAAW,EAAE,SAAS,EAAE,CAAC;KAC5B,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;OASG;IACG,MAAM,CACR,WAAW,EAAE,MAAM,EACnB,EACI,IAAI,EACJ,WAAW,GACd,GAAE;QACC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC;KACxB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;OAKG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E;;;;;;;;OAQG;IACG,SAAS,CACX,WAAW,EAAE,MAAM,EACnB,EAAE,IAAI,EAAE,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,EAChC,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CACN,EACI,WAAW,EACX,YAAY,EACZ,KAAqB,EACrB,KAAK,GACR,EAAE;QACC,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;CAqB3B"}

package/dist/api/edit/templates/client.js

@@ -174,19 +174,26 @@ export default class APIEditTemplates extends CompositionClient {
      *   - template_id: The template ID to use for filling
      *   - instructions: Instructions describing how to fill the form fields
      *   - model: LLM model for inference (default: "retab-small")
+     *   - color: Hex color code for filled text (default: "#000080")
      * @param options - Optional request options
      * @returns EditResponse containing:
      *   - form_data: List of form fields with filled values
      *   - filled_document: The filled PDF document as MIMEData
      */
-    async fill({ template_id, instructions, model = "retab-small", }, options) {
+    async fill({ template_id, instructions, model = "retab-small", color, }, options) {
+        const body = {
+            template_id,
+            instructions,
+            model,
+        };
+        if (color !== undefined) {
+            body.config = { color };
+        }
         return this._fetchJson(ZEditResponse, {
             url: "/v1/edit/templates/fill",
             method: "POST",
             body: {
-                template_id,
-                instructions,
-                model,
+                ...body,
                 ...(options?.body || {}),
             },
             params: options?.params,

package/dist/api/workflows/client.d.ts

@@ -1,48 +1,13 @@
-import { CompositionClient, RequestOptions } from "../../client.js";
-import { MIMEDataInput, WorkflowRun } from "../../types.js";
+import { CompositionClient } from "../../client.js";
+import APIWorkflowRuns from "./runs/client.js";
+/**
+ * Workflows API client for workflow operations.
+ *
+ * Sub-clients:
+ * - runs: Workflow run operations (create, get)
+ */
 export default class APIWorkflows extends CompositionClient {
+    runs: APIWorkflowRuns;
     constructor(client: CompositionClient);
-    /**
-     * Run a workflow with the provided input documents.
-     *
-     * This creates a workflow run and starts execution in the background.
-     * The returned WorkflowRun will have status "running" - use getRun()
-     * to check for updates on the run status.
-     *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param options - Optional request options
-     * @returns The created workflow run with status "running"
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.run({
-     *     workflowId: "wf_abc123",
-     *     documents: {
-     *         "start-node-1": "./invoice.pdf",
-     *         "start-node-2": Buffer.from(...)
-     *     }
-     * });
-     * console.log(`Run started: ${run.id}, status: ${run.status}`);
-     * ```
-     */
-    run({ workflowId, documents, }: {
-        workflowId: string;
-        documents: Record<string, MIMEDataInput>;
-    }, options?: RequestOptions): Promise<WorkflowRun>;
-    /**
-     * Get a workflow run by ID.
-     *
-     * @param runId - The ID of the workflow run to retrieve
-     * @param options - Optional request options
-     * @returns The workflow run
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.getRun("run_abc123");
-     * console.log(`Run status: ${run.status}`);
-     * ```
-     */
-    getRun(runId: string, options?: RequestOptions): Promise<WorkflowRun>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/workflows/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/workflows/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAa,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAErF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,GAAG,CAAC,EACN,UAAU,EACV,SAAS,GACZ,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KAC5C,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IA0BlD;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAQ9E"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/workflows/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;IAChD,IAAI,EAAE,eAAe,CAAC;gBAEjB,MAAM,EAAE,iBAAiB;CAIxC"}

package/dist/api/workflows/client.js

@@ -1,74 +1,14 @@
 import { CompositionClient } from "../../client.js";
-import { ZMIMEData, ZWorkflowRun } from "../../types.js";
+import APIWorkflowRuns from "./runs/client.js";
+/**
+ * Workflows API client for workflow operations.
+ *
+ * Sub-clients:
+ * - runs: Workflow run operations (create, get)
+ */
 export default class APIWorkflows extends CompositionClient {
     constructor(client) {
         super(client);
-    }
-    /**
-     * Run a workflow with the provided input documents.
-     *
-     * This creates a workflow run and starts execution in the background.
-     * The returned WorkflowRun will have status "running" - use getRun()
-     * to check for updates on the run status.
-     *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param options - Optional request options
-     * @returns The created workflow run with status "running"
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.run({
-     *     workflowId: "wf_abc123",
-     *     documents: {
-     *         "start-node-1": "./invoice.pdf",
-     *         "start-node-2": Buffer.from(...)
-     *     }
-     * });
-     * console.log(`Run started: ${run.id}, status: ${run.status}`);
-     * ```
-     */
-    async run({ workflowId, documents, }, options) {
-        // Convert each document to MIMEData format expected by backend
-        const documentsPayload = {};
-        for (const [nodeId, document] of Object.entries(documents)) {
-            const parsedDocument = await ZMIMEData.parseAsync(document);
-            // Extract base64 content from data URL
-            const content = parsedDocument.url.split(",")[1];
-            const mimeType = parsedDocument.url.split(";")[0].split(":")[1];
-            documentsPayload[nodeId] = {
-                filename: parsedDocument.filename,
-                content: content,
-                mime_type: mimeType,
-            };
-        }
-        return this._fetchJson(ZWorkflowRun, {
-            url: `/v1/workflows/${workflowId}/run`,
-            method: "POST",
-            body: { documents: documentsPayload, ...(options?.body || {}) },
-            params: options?.params,
-            headers: options?.headers,
-        });
-    }
-    /**
-     * Get a workflow run by ID.
-     *
-     * @param runId - The ID of the workflow run to retrieve
-     * @param options - Optional request options
-     * @returns The workflow run
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.getRun("run_abc123");
-     * console.log(`Run status: ${run.status}`);
-     * ```
-     */
-    async getRun(runId, options) {
-        return this._fetchJson(ZWorkflowRun, {
-            url: `/v1/workflows/runs/${runId}`,
-            method: "GET",
-            params: options?.params,
-            headers: options?.headers,
-        });
+        this.runs = new APIWorkflowRuns(this);
     }
 }

package/dist/api/workflows/runs/client.d.ts

@@ -0,0 +1,51 @@
+import { CompositionClient, RequestOptions } from "../../../client.js";
+import { MIMEDataInput, WorkflowRun } from "../../../types.js";
+/**
+ * Workflow Runs API client for managing workflow executions.
+ */
+export default class APIWorkflowRuns extends CompositionClient {
+    constructor(client: CompositionClient);
+    /**
+     * Run a workflow with the provided input documents.
+     *
+     * This creates a workflow run and starts execution in the background.
+     * The returned WorkflowRun will have status "running" - use get()
+     * to check for updates on the run status.
+     *
+     * @param workflowId - The ID of the workflow to run
+     * @param documents - Mapping of start node IDs to their input documents
+     * @param options - Optional request options
+     * @returns The created workflow run with status "running"
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.runs.create({
+     *     workflowId: "wf_abc123",
+     *     documents: {
+     *         "start-node-1": "./invoice.pdf",
+     *         "start-node-2": Buffer.from(...)
+     *     }
+     * });
+     * console.log(`Run started: ${run.id}, status: ${run.status}`);
+     * ```
+     */
+    create({ workflowId, documents, }: {
+        workflowId: string;
+        documents: Record<string, MIMEDataInput>;
+    }, options?: RequestOptions): Promise<WorkflowRun>;
+    /**
+     * Get a workflow run by ID.
+     *
+     * @param runId - The ID of the workflow run to retrieve
+     * @param options - Optional request options
+     * @returns The workflow run
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.runs.get("run_abc123");
+     * console.log(`Run status: ${run.status}`);
+     * ```
+     */
+    get(runId: string, options?: RequestOptions): Promise<WorkflowRun>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/api/workflows/runs/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/workflows/runs/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,aAAa,EAAa,WAAW,EAAgB,MAAM,mBAAmB,CAAC;AAExF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,iBAAiB;gBAC9C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CACR,EACI,UAAU,EACV,SAAS,GACZ,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KAC5C,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IA0BvB;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAQ3E"}

package/dist/api/workflows/runs/client.js

@@ -0,0 +1,77 @@
+import { CompositionClient } from "../../../client.js";
+import { ZMIMEData, ZWorkflowRun } from "../../../types.js";
+/**
+ * Workflow Runs API client for managing workflow executions.
+ */
+export default class APIWorkflowRuns extends CompositionClient {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * Run a workflow with the provided input documents.
+     *
+     * This creates a workflow run and starts execution in the background.
+     * The returned WorkflowRun will have status "running" - use get()
+     * to check for updates on the run status.
+     *
+     * @param workflowId - The ID of the workflow to run
+     * @param documents - Mapping of start node IDs to their input documents
+     * @param options - Optional request options
+     * @returns The created workflow run with status "running"
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.runs.create({
+     *     workflowId: "wf_abc123",
+     *     documents: {
+     *         "start-node-1": "./invoice.pdf",
+     *         "start-node-2": Buffer.from(...)
+     *     }
+     * });
+     * console.log(`Run started: ${run.id}, status: ${run.status}`);
+     * ```
+     */
+    async create({ workflowId, documents, }, options) {
+        // Convert each document to MIMEData format expected by backend
+        const documentsPayload = {};
+        for (const [nodeId, document] of Object.entries(documents)) {
+            const parsedDocument = await ZMIMEData.parseAsync(document);
+            // Extract base64 content from data URL
+            const content = parsedDocument.url.split(",")[1];
+            const mimeType = parsedDocument.url.split(";")[0].split(":")[1];
+            documentsPayload[nodeId] = {
+                filename: parsedDocument.filename,
+                content: content,
+                mime_type: mimeType,
+            };
+        }
+        return this._fetchJson(ZWorkflowRun, {
+            url: `/v1/workflows/${workflowId}/run`,
+            method: "POST",
+            body: { documents: documentsPayload, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get a workflow run by ID.
+     *
+     * @param runId - The ID of the workflow run to retrieve
+     * @param options - Optional request options
+     * @returns The workflow run
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.runs.get("run_abc123");
+     * console.log(`Run status: ${run.status}`);
+     * ```
+     */
+    async get(runId, options) {
+        return this._fetchJson(ZWorkflowRun, {
+            url: `/v1/workflows/runs/${runId}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+}