You can inspect a document inside the editor or generate a PDF to download and use. Preview supports design work; rendering creates a job with a status, history, and output file. Choose based on the task you need to complete.
1. Preview while editing
Use Layout and PDF in the editor to inspect structure and pagination. Draft versions can be previewed without publication.
Preview does not consume successful-render quota or create a retained PDF entry in Renders. Resource and processing-time limits still apply.
Layout reflects your current edits. PDF renders saved template content, so save the design and regenerate PDF preview after changes. Preview parameters come from the editor’s values, initially Defaults; values entered in Run apply only to Run jobs. A previous PDF preview does not refresh automatically.
2. Render when you need an output file
Use Run or the render API to generate a PDF. The version must be published, and the key needs template:render permission in the same project.
A successful job counts toward quota, appears in Renders, and has downloadable output during its retention period. Run inside the editor creates this same type of job.
3. Choose the right route for each step
| Task | Use |
|---|---|
| Edit typography, margins, content, or breaks | Editor preview. |
| Test data against a published version | Run. |
| Generate PDFs from your software | Render API. |
| Find a job’s output or error | Renders. |
To try a job without building an integration, start with Run.
4. When preview works but Run does not
Compare the version open in the editor with the one selected in Run: the selections can differ. Then check publication status, the selected key, and input values.
If a job was accepted, open its result in Renders for the specific error. Acceptance does not mean the PDF is finished; download it once status is success and output is available.