Streaming and asynchronous jobs

As in API, there are two different mechanisms:

Response Streaming (/convert/stream, /convert/stream-from-url): Progressive Markdown fragments while the server converts.
Jobs due to saturation (202): when all backends are busy, the request is queued and responded to 202 with a job_id. See GET /jobs/{id}.

Streaming with `convertStream`

const client = new MarkpdfClient({ apiKey: "YOUR_API_KEY" });

for await (const chunk of client.convertStream({ data: buffer }, { filename: "report.pdf" })) {
  process.stdout.write(chunk);
}

convertStream returns a AsyncIterable<string> — use it with for await...of in Node/Deno/Bun, or consume the iterator manually.

for await (const chunk of client.convertStream({ data: buffer }, { filename: "report.pdf", slim: true })) {
  handle(chunk);
}

for await (const chunk of client.convertStream({ url: "https://bucket.example.com/report.pdf?sig=..." }, { slim: true })) {
  handle(chunk);
}

export async function GET(req: Request) {
  const stream = new ReadableStream({
    async start(controller) {
      const encoder = new TextEncoder();
      for await (const chunk of client.convertStream({ url: pdfUrl })) {
        controller.enqueue(encoder.encode(chunk));
      }
      controller.close();
    },
  });
  return new Response(stream, { headers: { "content-type": "text/markdown" } });
}

`streamSlimStrategy`

client.convertStream({ data: buffer }, { slim: true, streamSlimStrategy: "sampled" });

"off": pure streaming per page, without noise detection. TTFB minimum.
"sampled" (default): Sample the first few pages, then output per page.
"full": materializes the entire document before issuing. Better cleaning, worse TTFB.

See Parameters.

Jobs due to saturation (202)

By default, convertFile and convertFromUrl handle 202 transparently (autoPoll: true):

// SDK waits and polls automatically
const markdown = await client.convertFile(buffer, { filename: "report.pdf" });

Poll manual

import { MarkpdfJobQueuedError } from "@markpdf/sdk";

try {
  const markdown = await client.convertFile(buffer, {
    filename: "report.pdf",
    autoPoll: false,
  });
} catch (err) {
  if (err instanceof MarkpdfJobQueuedError) {
    console.log(`En cola: ${err.jobId}`);
    let status;
    do {
      await new Promise((r) => setTimeout(r, err.retryAfterSeconds * 1000));
      status = await client.getJob(err.jobId);
    } while (status.status === "queued" || status.status === "processing");

    if (status.status === "completed") {
      const markdown = status.body as string;
    } else {
      throw new Error(status.error);
    }
  } else {
    throw err;
  }
}

Under normal load conditions you won’t see 202 — it only happens when all backends are saturated. autoPoll: true (the default) already covers it without additional code in most cases.

Results for completed jobs expire in approximately 1 hour. If you save a jobId and receive 404 when querying it, resend the original conversion.

Python

Node.js / TypeScript

C++

Next.js

Angular

React

React Native

Svelte

Bun

Flutter

Java

Kotlin

Streaming and asynchronous jobs

Streaming and asynchronous jobs

Streaming with `convertStream`

`streamSlimStrategy`

Jobs due to saturation (202)

Poll manual

​Streaming and asynchronous jobs

​Streaming with convertStream

​streamSlimStrategy

​Jobs due to saturation (202)

​Poll manual

Streaming and asynchronous jobs

Streaming with `convertStream`

`streamSlimStrategy`

Jobs due to saturation (202)

Poll manual