Render an HTML template to an image with dynamic layer updates

post

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

Render an HTML template to an image. Upload an HTML file and specify layer updates using dot notation. Layers are targeted by HTML element ID attribute. Supports text content updates (layers.{id}.content), CSS style updates (layers.{id}.{css-property}), and image updates (src, background-image). CSS property names must use kebab-case (e.g. background-color, font-size). Example: layers.header_text.content="Hello" or layers.logo.src=(file upload).

Body Params

HTML template rendering request parameters (form-data)

html_file

file

required

The HTML template file to render (max 30MB)

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:

width

number

Fixed width for rendering in pixels (optional)

height

number

Fixed height for rendering in pixels (optional)

layers.{id}.content

string

Update text content for an element by ID

layers.{id}.src

Upload an image file to replace src attribute

layers.{id}.background-image

Upload an image file to replace background-image

layers.{id}.color

string

Update text color for an element by ID

layers.{id}.background-color

string

Update background color for an element by ID

layers.{id}.{css-property}

string

Update any CSS property for an element by ID (e.g., font-size, border, padding)

Headers

string

enum

Defaults to image/png

Generated from available response content types

Allowed:

Responses

400

Bad request. May be missing required file, invalid HTML, file too large, or invalid layer updates (e.g., element ID not found).

500

Internal server error. Unable to render image from HTML.

200The image was successfully rendered from HTML template.