Skip to main content
Glama
formfeed-dev

formfeed

Official
by formfeed-dev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Render a document

render

Creates a document by filling a stored template, or ad-hoc html, with data: a PDF or image, or DOCX, PPTX or PDF from Word and PowerPoint templates. Returns the render with status and download_url.

Instructions

Creates a document by filling a stored template, or ad-hoc html, with data: a PDF or image, or DOCX, PPTX or PDF from Word and PowerPoint templates. Returns the render with status and download_url. Use it to make a document from data; to turn an existing office file into a PDF, use convert_to_pdf. Stored templates render their published version, so one whose published_version is null fails with template_not_found. Every call is a new render: a live key consumes units, a test key is free (watermarked on the Free plan). A render that fails returns status failed and an error with code and message; validate_template finds most causes beforehand. With einvoice the PDF becomes a ZUGFeRD / Factur-X e-invoice built from data._invoice (check the block with check_invoice first): the render then carries einvoice, the validator's report, and a refused invoice names the fields and rules to fix. The link expires at expires_at; get_render issues a fresh one.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoValues for the template, shaped as get_template_schema describes; leave out when it needs none
htmlNoA complete HTML document to render instead of a stored template, up to 5 MB
waitNoMost renders are finished when the call returns; true also waits for one that continues in the background, false returns it as it is (queued or rendering) to check later with get_render
engineNoTemplate language of html, when it contains expressions to fill from data
localeNoBCP 47 tag for helpers and translations, e.g. de-DE
outputNoLeft out, the template decides: PDF for PDF templates and html, its image format for image templates, its default output for Word and PowerPoint templates. Word templates render docx or pdf, PowerPoint templates pptx or pdf
einvoiceNoMakes the PDF a ZUGFeRD / Factur-X e-invoice whose XML is built from data._invoice: true for the defaults, an object to choose, false to switch off what the template declares. PDF only; live renders from the Starter plan, test keys on Free make 20 marked ones a day
filenameNoName of the file behind download_url, e.g. invoice-2026-0042.pdf
templateNoSlug or tpl_ id of a stored template; pass this or html

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.17
    • addedInput schema / properties / einvoice
      Added value: +{
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "properties": {
+        "display_check": {
+          "description": "What a value of the XML that the PDF does not show does: a warning in the report (default) or a failed render",
+          "enum": [
+            "warn",
+            "strict"
+          ],
+          "type": "string"
+        },
+        "flavour": {
+          "description": "One specification under two names; the default factur-x and zugferd make the same file",
+          "enum": [
+            "factur-x",
+            "zugferd"
+          ],
+          "type": "string"
+        },
+        "profile": {
+          "description": "en16931 (default) carries the whole European standard; basic is the smallest full invoice and is refused between two French businesses",
+          "enum": [
+            "en16931",
+            "basic"
+          ],
+          "type": "string"
+        },
+        "xml": {
+          "description": "both also stores the XML as a file of its own, linked as einvoice.xml_url",
+          "enum": [
+            "embedded",
+            "both"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  ],
+  "description": "Makes the PDF a ZUGFeRD / Factur-X e-invoice whose XML is built from data._invoice: true for the defaults, an object to choose, false to switch off what the template declares. PDF only; live renders from the Starter plan, test keys on Free make 20 marked ones a day"
+}
  2. Changed6 schema fields changedv0.3.10
    • addedInput schema / properties / data / description
      Added value: +"Values for the template, shaped as get_template_schema describes; leave out when it needs none"
    • changedInput schema / properties / engine / description
      Previous value: -"Engine for html that contains template syntax"New value: +"Template language of html, when it contains expressions to fill from data"
    • addedInput schema / properties / filename / description
      Added value: +"Name of the file behind download_url, e.g. invoice-2026-0042.pdf"
    • changedInput schema / properties / html / description
      Previous value: -"Raw HTML instead of a template"New value: +"A complete HTML document to render instead of a stored template, up to 5 MB"
    • changedInput schema / properties / template / description
      Previous value: -"Template slug or tpl_ id"New value: +"Slug or tpl_ id of a stored template; pass this or html"
    • changedInput schema / properties / wait / description
      Previous value: -"Wait for the render to finish (sync renders finish immediately)"New value: +"Most renders are finished when the call returns; true also waits for one that continues in the background, false returns it as it is (queued or rendering) to check later with get_render"
  3. First observedv0.3.7

TDQS

Score is being calculated.

Deploy Server

Other Tools