@pleias/stratum-client (TypeScript / JavaScript)

Official TypeScript client for the Stratum document-chunking API. Works in Node 18+ and modern browsers (anywhere fetch, FormData, and Blob are available).

npm install @pleias/stratum-client

Quick start

import { readFile } from "node:fs/promises";
import { Client } from "@pleias/stratum-client";

const client = new Client({ apiKey: "stratum_xxxxxxxx_..." });
// or: process.env.STRATUM_API_KEY is picked up automatically.

const blob = new Blob([await readFile("report.pdf")]);
const job = await client.submitJob(blob, { filename: "report.pdf" });

const result = await client.waitForJob(job.id);
for (const chunk of result.chunks ?? []) {
  console.log(chunk.text);
}

Client

new Client({
  apiKey?: string,                               // falls back to STRATUM_API_KEY
  baseUrl?: string,                              // default: https://api-stratum.pleias.dev
  fetch?: typeof fetch,                          // injectable for testing
  timeoutMs?: number,
});

Methods:

| Method | Description | | --------------------------- | ---------------------------------------------------------------------- | | healthz() / readyz() | Liveness / readiness probes | | submitJob(file, options?) | Upload a document (Blob, ArrayBuffer, Uint8Array, or { name, data }) | | getJob(id) | Fetch a single job | | listJobs(params?) | Paginated job list | | iterJobs(params?) | AsyncGenerator<Job> that auto-pages | | getJobResult(id) | Download the chunker output | | cancelJob(id) | Delete a job and its storage artifacts | | waitForJob(id, options?) | Poll until the job ends; returns the result |

Errors

All errors derive from StratumError:

• AuthenticationError (401/403)
• NotFoundError (404)
• JobNotCompleteError (409 — result requested before job finished)
• ApiError (other non-2xx)
• JobFailedError (raised by waitForJob when the job ends in failed)