API operations

Every endpoint, grouped in the sidebar — one group per utility, plus Jobs and the utility catalog — with method badges. Pick an operation to see its parameters, request and response schemas, and copy-paste code samples. It's all rendered from our OpenAPI spec, which is generated from the same schemas the server validates with, so it never drifts from the running API.

New to the API? Start with the API reference for authentication, the request envelope, sync vs async and status codes, then explore the operations here.

↓ Download OpenAPI← API referenceConventions & errors

Run a utility (sync)→POST /v1/utilities/html-pdf — wait for the finished job.Start a job (async)→POST /v1/utilities/split-pdf/jobs — get a job id at once.Get a job→GET /v1/jobs/{id} — the result by job id, with ?wait long-polling.List jobs→GET /v1/jobs — this key's jobs, newest first.List utilities→GET /v1/utilities — what this key can call, with input schemas.

Every utility, two ways in

Utility	Sync	Async
HTML → PDF	runHtmlPdf	createHtmlPdfJob
Split PDF	runSplitPdf	createSplitPdfJob
Zip files	runZipFiles	createZipFilesJob
Unzip archive	runUnzipFiles	createUnzipFilesJob
XLS → XLSX	runXlsToXlsx	createXlsToXlsxJob

Jobs: getJob · listJobs · cancelJob. Catalog: listUtilities · getUtility.