Render an image template with dynamic layer and background updates

post

https://api.jasper.ai/beta/image-template/render

Generate multiple variations of advertising images connecting a predefined template with dynamic content. You can dynamically update layer properties and page background using dot notation in form fields. For layers: "layers.author.text.content" to update text content. For background: "background.color" for solid colors or "background.imageFile" for image backgrounds. Only layers.* and background.* form fields will be processed as dynamic updates, other fields are ignored.

Body Params

Multi-layer image composition request parameters (form-data)

template_id

uuid

required

Id of the template to render.

scale

number

0 to 4

Defaults to 1

Scale factor for the rendered image (0 < scale <= 4). Default: 1

format

string

enum

Defaults to png

Output image format. Default: png

Allowed:

layers.{name}.text.content

string

Update text content for a text layer

layers.{name}.text.color

string

Update text color

layers.{name}.text.font

file

Upload a custom font file for a text layer (TTF, OTF, WOFF, WOFF2). Max size: 5MB

layers.{name}.text.opacity

string

≤ 1

Set text layer opacity, value is a number between 0 and 1

layers.{name}.text.isVisible

string

enum

Set text layer visibility

Allowed:

layers.{name}.text.backgroundColor

string

Update text background color

layers.{name}.image.imageFile

layers.{name}.image.fit

string

enum

Auto-fit the image to the layer. Requires providing layers.{name}.image.imageFile in the same request. "contain": no crop, resize and center the image. "cover": crop to fill the layer. Fit will override any existing crop attributes in the template

Allowed:

layers.{name}.image.cropWidth

string

0 to 1

Defaults to 1

Crop width as percentage (0-1). Cannot be used with fit attribute.

layers.{name}.image.cropHeight

string

0 to 1

Defaults to 1

Crop height as percentage (0-1). Cannot be used with fit attribute.

layers.{name}.image.cropX

string

0 to 1

Defaults to 0

Crop X offset as percentage (0-1). Cannot be used with fit attribute.

layers.{name}.image.cropY

string

0 to 1

Defaults to 0

Crop Y offset as percentage (0-1). Cannot be used with fit attribute.

layers.{name}.image.opacity

string

0 to 1

Set image layer opacity, value is a number between 0 and 1

layers.{name}.image.isVisible

string

enum

Set image layer visibility

Allowed:

background.color

string

Set page background to a solid color (e.g., "rgba(245,166,35,1)", "#FF0000", "white"). Cannot be used with background.imageFile.

background.imageFile

file

Upload an image file for page background (PNG, JPEG, WebP). Max size: 5MB. Cannot be used with background.color.

layers.{name}.svg.color

string

Update SVG fill color

layers.{name}.svg.opacity

string

0 to 1

Set svg layer opacity, value is a number between 0 and 1

layers.{name}.svg.isVisible

string

enum

Set svg layer visibility

Allowed:

Headers

string

enum

Defaults to image/png

Generated from available response content types

Allowed:

Responses

400

Bad request. May be missing required inputs or may have badly formatted inputs or options.

404

Template not found or access denied.

500

Internal server error. Unable to render image.

200The image was successfully rendered.