Run lets you supply data and create PDFs inside the editor. Select the template edition, fill in its inputs, and inspect the result in one place before connecting the template to your software.
1. Select a key, version, and variant
Save and publish the intended version, then open Run. Select a project API key with template:render, a Version, and a Variant name. Create a key in API Keys if needed.
Run’s selectors are independent of the open editor view. You can run v1 while viewing v2. Changing Version loads that saved version’s Parameters, Defaults, and Variants; wait for it to load before entering data. Inputs are kept separately for each template version in this browser. Draft versions can be selected, but must be published before rendering.
2. Fill in the job’s Parameters
Expand Parameters in Run and edit the test values. Fields come from the declared schema; objects and arrays still need their correct types.
These inputs belong to the PDF job and do not change the template’s Defaults. Resetting inputs restores the default Parameter values.
{ "recipient": "Tembuilder", "copies": 2 }3. Generate a PDF and open the result
Choose Render. The job appears in Run’s history while processing. Open its result row to view status and download the PDF on success.
Run performs real rendering: successful jobs count toward quota and produce retained output. Use editor preview while adjusting the layout.
For a failed job, open its error details to identify whether the input, template, or usage conditions need attention before retrying.
4. Copy a request to start integrating
Run’s copy menu offers cURL, JavaScript, and Python. Snippets use <YOUR_API_KEY>; supply the key in your own execution environment.
The snippet uses the version, variant, and input values currently selected in Run. Copy it after choosing the combination you intend to integrate; changing the form afterwards does not change a snippet already copied. For request fields, status, and download endpoints, see Render API reference.