Skip to content
Coming soon. The hosted API is not live yet, and this page describes the planned service as of 16 November 2026. Get notified when it opens.

Async jobs

A synchronous call returns the result in the response. Work that takes longer, and work on files you keep elsewhere, runs as a job: you name the files by URL, the service processes them and delivers the result.

POST /v1/jobs with a JSON body:

Field Meaning
inputs The input files, as { "url": ... } objects.
operation Operation id or tool name
options The operation’s options
output_url HTTPS URL that receives the result with PUT
webhook_url Receives the job id and status, never the document
Terminal window
curl -sS -f -X POST "$PDFLUENT_API_URL/v1/jobs" \
-H "x-api-key: $PDFLUENT_API_KEY" \
-H "content-type: application/json" \
-d '{"operation":"extract.markdown","inputs":[{"url":"https://files.example.com/report.pdf"}],"options":{"quality":"fast"}}'

The response is 202: the job is queued.

Route Does
GET /v1/jobs/{id} Status of a job.
GET /v1/jobs/{id}/result Download the result.
DELETE /v1/jobs/{id} Delete a job and its result now.
POST /v1/uploads Signed URLs for one input document, for a client with no presigned URL of its own: PUT the file to upload_url, then pass input_url to a job.

A job result, and a file you upload through the upload URL, is held for 15 minutes, then deleted.

Pass output_url to have the result delivered to your own storage with a PUT; pass webhook_url to be told when the job is done. The webhook receives the job id and status, never the document.