Reference

PDFDesignAPI glossary

Definitions for templates, schemas, bindings, versions, environments, render jobs, and batches.

Reviewed 2026-08-05 · PDFDesignAPI Engineering

Design terms

Template: a document design and its data contract. Schema: the structured fields available to a template. Example data: representative values used during design. Binding: a connection from a component to schema data.

Lifecycle terms

Version: an immutable numeric template save. Development: the alias advanced by saves. Staging: an explicitly promoted test alias. Production: the explicitly promoted live alias.

Rendering terms

Synchronous generation: PDF returned in the request. Render job: durable asynchronous work with a UUID and state. Batch: a group of independently tracked render jobs. Idempotency key: a caller-supplied identifier used to make safe matching retries.

Was this page helpful?

Need help with an implementation detail?

Contact technical support →