Set the paper size of a generated PDF

Paper size. Ignored if the page CSS declares its own @page size.

What it is for

Picks the paper the page is laid out on. A4 by default, which is right everywhere except North America — Letter is 8.5×11in against A4’s 8.27×11.69in, so a layout tuned for one overflows the other by a few millimetres rather than obviously.

The trap

Ignored entirely if your CSS declares its own @page size. That is not a bug: a stylesheet that says @page { size: A5 } has stated an intention this option should not override. If format seems to do nothing, grep your CSS for @page first.

Example

curl -X POST https://api.pdfcraft.dev/v1/render \
  -H "Authorization: Bearer $PDFCRAFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>hello</h1>",
    "options": {
      "format": "Letter"
    }
  }' \
  --output out.pdf

Every option

• format — Paper size. Ignored if the page CSS declares its own @page size.
• landscape — Rotate the paper to landscape orientation.
• margin — Page margins. Any side may be omitted; omitted sides default to 0.
• scale — Rendering scale factor.
• printBackground — Print background colours and images. Off by default in browsers; on by default here.
• pageRanges — Subset of pages to keep, e.g. "1-5" or "1,4,7-9". Empty means all pages.
• headerHtml — HTML for the running header. Supports Chromium print classes: date, title, url, pageNumber, totalPages. Needs a top margin to be visible.
• footerHtml — HTML for the running footer. Same classes as headerHtml; needs a bottom margin.
• waitFor — Conditions to satisfy before the PDF is taken. All of them apply, in order.
• emulateMedia — Which CSS media type the page sees.
• timeoutMs — Hard ceiling on the whole render. Exceeding it returns 408 render_timeout.

Try any of these in the playground without writing a line of code, or read the full reference.