Create an image

Create an image render. Async on api.bannerbear.com (returns 202 + pending record, poll via GET /images/{uid} or subscribe via webhook). Sync on sync.api.bannerbear.com (returns 200 + completed image inline, or 408 if the render exceeds the sync timeout).

post/images

Request body

templatestring required

Template UID

formatsstring[]

Output file formats

scale1 | 2 | 3 | 4

Output scale multiplier for higher resolution

dpiinteger

DPI metadata embedded in the output image for print sizing

qualityinteger

Compression quality for JPG/WebP output

proxyboolean

Proxy and resize external images before rendering

metadatastring

Arbitrary metadata string stored with the image

versioninteger

Target a specific template version number

Response

Sync render complete (sync host only)

uidstring

status'pending' | 'completed' | 'failed'

templatestring

filesobject

Output file URLs keyed by format

metadatastring nullable

errorstring nullable

Error message (only present on failure)

selfstring uri

created_atstring date-time

completed_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.