Sign in

v1

latestOpenAPI 3.1.0Commercial License2026-08-064614.8 KB
Image Automation

Generate an image from a template (Image Automation API)

Generate images such as social media visuals, banners and more from a saved Document template. You can change text, colors, images and other properties in one request.

post/api/graphic/automation/v2

Request body

document_uidstring

UID of the Document to use as template.

template_namestring

Name of the Document to use as template.

api_keystring required

Your API key (same value as Authorization header).

format'image' | 'json' | 'base64' | 'pdf' | 'html'

Expected output format.

image_type'jpeg' | 'png'

Output image type.

custom_fieldstring

Optional field returned in JSON response when format=json or html.

Response

Image generated successfully. Response format depends on the 'format' parameter.

statusstring
created_atstring
image_urlstring uri
uidstring
custom_fieldstring

Example response

{
  "status": "success"
}