Export an edited image

Render a finished image using the same settings as the editor. Export uses no extra credits. Add ?prepare=true to receive a private download URL.

POST/api/jobs/{id}/export

Authenticate with X-API-Key. Keep your key on your server; never embed it in a public website.

Request parameters

formatstringdefault: png

Output format.

pngjpgwebp

sizestringdefault: full

Output dimensions.

fullpreview

settingsobject

Editor settings. See the edit example.

backgroundstring

An included background path or a background URL returned for this job.

maskstring

Optional Base64 PNG alpha mask from the manual brush.

Editor settings

Pass these inside settings. Omitted fields use the defaults below. Preset canvases are limited to 4096 pixels per side; the original ratio preserves the source size.

Field	Default	Values
`bgMode`	transparent	transparent, color, gradient, photo, original
`bgColor / bgColor2`	#ffffff / #f3e5cd	Hex colors for solid / gradient backgrounds
`blur`	0	0–40; background blur
`shadow`	0	0–100; opacity percentage
`shadowType`	drop	drop, ground, car
`ratio`	original	original, square, portrait (4:5), story (9:16), landscape (16:9)
`scale`	100	10–200 percent
`offsetX / offsetY`	0	−100 to 100 percent of canvas
`rotation`	0	−180 to 180 degrees
`flip`	false	Boolean; horizontal flip
`brightness / contrast / saturation`	100	0–200 percent
`text`	empty	Caption, up to 500 characters
`textSize`	48	10–150; scaled with canvas size
`textColor`	#ffffff	Caption hex color
`textY`	85	0–100 percent; vertical caption position

Response

200 · Success

{
  "binary": "Rendered image bytes"
}

Errors use a structured error.code and error.message. See error handling →