PdfBroker.io

{
  "type": "object",
  "properties": {
    "url": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "Optional https URL of an already published HTML document, fetched by PdfBroker instead of sending the markup inline. Use this to keep a large template out of the conversation. Only https is accepted, and addresses on private networks or cloud metadata endpoints are refused. If both 'url' and 'html' are supplied, 'url' wins. Relative images, fonts and stylesheets in the document resolve against the document's own URL, so the 'resources' parameter has no effect on a url render. paperSize and orientation cannot be applied to a url render with this engine — the published document's own @page rule decides."
    },
    "html": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "Complete HTML document string including <html>, <head>, <style>, and <body> tags. Use CSS for styling. WeasyPrint supports CSS Paged Media for headers, footers, and page numbers via @page margin boxes. Optional if 'url' is supplied instead — pass exactly one of the two."
    },
    "pdfForms": {
      "type": "boolean",
      "default": false,
      "description": "Set to true to produce a fillable PDF: the document's <input>, <select> and <textarea> elements become interactive form fields a recipient can type into and save. Default false, which flattens them into static text. Note that form fields and strict tagging can interact — if the engine refuses a combination of forms and a conformanceLevel, its message is returned as-is."
    },
    "paperSize": {
      "type": "string",
      "default": "Auto",
      "description": "Paper size: 'Auto' (default) leaves the page to the document's own CSS — an @page rule such as '@page { size: A5 landscape; }' decides, and when the document says nothing you get A4 portrait (EU-first default). Name a size to override the document: 'A4' (210x297mm), 'Letter' (8.5x11in), 'A3' (297x420mm), 'Legal' (8.5x14in). An explicitly named size wins over the document's own @page rule."
    },
    "resources": {
      "type": [
        "object",
        "null"
      ],
      "default": null,
      "description": "Optional embedded resources referenced by relative path in the HTML (images, custom fonts via @font-face, stylesheets, etc.). Keys are relative paths (e.g., 'images/logo.png'), values are base64-encoded file contents. Unused entries are silently ignored. Invalid base64 returns a clear, key-named error before the API call is made.",
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "orientation": {
      "type": "string",
      "default": "Auto",
      "description": "Page orientation: 'Auto' (default) leaves it to the document's CSS, 'Portrait' or 'Landscape' override it. Combine with paperSize for a full override, or use it alone to rotate whatever size the document declares."
    },
    "extraArguments": {
      "type": [
        "object",
        "null"
      ],
      "default": null,
      "description": "Optional extra WeasyPrint engine arguments forwarded verbatim to the engine. Keys are CLI long-form options without '--'. For switch-style flags use an empty-string value — example: {\"presentational-hints\": \"\"}. On key collision with structured parameters (conformanceLevel, paperSize, orientation), the user-supplied extra wins. See the docs://pdfbroker/api-reference resource for the supported argument list.",
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "conformanceLevel": {
      "type": "string",
      "default": "None",
      "description": "PDF compliance standard. 'None' (default) requests no conformance. Archival, level B — visual fidelity: 'PdfA1b' (widest compatibility), 'PdfA2b', 'PdfA3b' (allows embedded attachments, used for e-invoicing). Archival, level U — level B plus guaranteed Unicode text extraction: 'PdfA2u', 'PdfA3u'. Archival, level A — level U plus a tagged structure tree, so the file is archival AND accessible in one document: 'PdfA1a', 'PdfA2a', 'PdfA3a'. PDF/A-4 (PDF 2.0, thinner reader support): 'PdfA4u' (baseline), 'PdfA4f' (embedded files), 'PdfA4e' (engineering). Note there is no PDF/A-4b — PDF/A-4 dropped the A/B lettering. Accessibility: 'PdfUA1' (European Accessibility Act; use this unless UA-2 was asked for), 'PdfUA2'. Print production: 'PdfX1a', 'PdfX3', 'PdfX4', 'PdfX5g'. The raw engine value is also accepted (e.g. 'pdf/a-2b'). Use PdfUA1 when the document must be accessible to screen readers, and PdfA2a when it must be both archival and accessible. An unknown value is rejected rather than silently ignored."
    }
  }
}