cURL
API Reference
Generate Design
Render one or more images from a Pixy design or template.
POST
cURL
Allowed Modifications
Review the Modifications guide for the full support matrix and example payloads.Authorizations
Organization API key passed as a bearer token.
Path Parameters
Pixy design or template identifier.
Body
application/json
Output format. Defaults to jpeg. jpg is also accepted and normalized to jpeg.
Available options:
png, jpeg, pdf Optional object-level overrides applied before rendering.
Supported overrides are inferred from the current implementation: text replacement for text objects, fill/stroke color replacement for text, image, and SVG objects, and source image replacement for image objects.
Response
Successfully rendered one or more output files.