Convert

Queue a large document

Changed on

Asynchronous rendering for HTML or Markdown up to 100 pages. The document is rendered once at submission to count its pages, so this call can take nearly 30 seconds and returns 400 PAGE_LIMIT_EXCEEDED immediately when the document is too long.

post/longjob

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/longjob
  • Auth: API key in header X-API-Key

Request body

input_type'html' | 'markdown' required
htmlstring
markdownstring
webhook_urlstring uri

Validated but ignored; register webhooks through the dashboard.

email_notificationboolean

false skips the "PDF ready" / "conversion failed" email for this job. Omit to follow the account's email settings; true cannot turn it on when job emails are off.

pdf_standard'pdf/ua-1' | 'pdf/ua-2'

Alpha. Make an accessible, tagged PDF that conforms to PDF/UA-1 (ISO 14289-1, PDF 1.7) or PDF/UA-2 (ISO 14289-2, PDF 2.0). For input_type html and markdown and for template renders; other inputs return 400. Leave it out for an ordinary PDF.

PodPDF adds what the file itself needs (tags, language, title, metadata, link descriptions, artifacts for page furniture) and checks the result with veraPDF. What depends on your HTML stays yours: alt text on images, headings in order, header cells in tables. The check's verdict comes back in X-PDF-Conformance (or conformance in JSON). Built-in templates pass both standards.

titlestring

Alpha. With pdf_standard: the document title, shown by PDF readers. Defaults to the page's <title>, then its first heading. Ignored without pdf_standard.

langstring

Alpha. With pdf_standard: the document language as a language tag. Defaults to the page's <html lang>, then en. Ignored without pdf_standard.

Example request

{
  "options": {
    "margin": {
      "top": "20mm",
      "right": "20mm",
      "bottom": "20mm",
      "left": "20mm"
    },
    "width": "100mm",
    "height": "150mm",
    "pageRanges": "1-3, 5"
  },
  "lang": "en-GB"
}

Response

Queued

job_idstring
statusstring
messagestring
estimated_completionstring date-time

Always three minutes after submission; a placeholder, not an estimate.

Example response

{
  "job_id": "9f0a4b78-2c0c-4d14-9b8b-123456789abc",
  "status": "queued"
}

Changes

  • 84eb21f3ee27Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property