​

Streaming and asynchronous jobs

1. Response Streaming (/convert/stream, /convert/stream-from-url): The server outputs the Markdown in progressive chunks while converting, to lower the TTFB in large documents.
2. Saturation Jobs (202): When all backends are busy, any conversion endpoint queues the request and responds 202 with a job_id to query later. See GET /jobs/{id}.

​

Streaming with convert_stream

import markpdf

client = markpdf.Client(api_key="YOUR_API_KEY")

for chunk in client.convert_stream("informe-grande.pdf"):
    print(chunk, end="", flush=True)

for chunk in client.convert_stream("report.pdf", slim=True):
    handle(chunk)

for chunk in client.convert_stream(url="https://bucket.example.com/report.pdf?sig=...", slim=True):
    handle(chunk)

async with markpdf.AsyncClient(api_key="YOUR_API_KEY") as client:
    async for chunk in client.convert_stream("report.pdf"):
        handle(chunk)

​

stream_slim_strategy

client.convert_stream("report.pdf", slim=True, stream_slim_strategy="sampled")

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

​

Jobs due to saturation (202)

# auto_poll=True (default): SDK waits and polls for you
markdown = client.convert_file("report.pdf")

1. Read job_id and retry_after_seconds of the answer.
2. Sleep retry_after_seconds (5s by default).
3. Llama GET /jobs/{job_id}.
4. Repite mientras status sea "queued" o "processing".
5. Returns body when status == "completed", or throws MarkpdfJobFailedError if status == "failed".

​

Poll manual

from markpdf import MarkpdfJobQueuedError

try:
    markdown = client.convert_file("report.pdf", auto_poll=Failedse)
except MarkpdfJobQueuedError as job:
    print(f"En cola: {job.job_id}")
    while True:
        status = client.get_job(job.job_id)
        if status.status == "completed":
            markdown = status.body
            break
        if status.status == "failed":
            raise RuntimeError(status.error)
        time.sleep(job.retry_after_seconds)