Guides

Operations

OperationDescription
redeye_removeSee Image Remove Red-eye addon for parameter details
bg_removeSee Image Remove Background addon for parameter details
autofixSee Image Autofix addon for parameter details
bg_addSee below
border_addSee below
graphics_addSee below

Options for bg_add

ParameterTypeDescription
colorstring(optional) Color to applied to the background. Does not apply for border_add
image_idstring(optional, If image_url is supplied) id of the image asset to be used as background
modestring(optional) Mode to be used for the background image. Can be "as-is" (to use the background image as-is) or "stretch" (to stretch the background image to fit the image). Defaults to "stretch"

options for border_add

ParameterTypeDescription
image_idstringId of the image asset to be used

Options for graphics_add

A list of graphics can be added to the image. Each graphics can be of type image. The graphics can be added to the image using the position parameter.

ParameterTypeDescription
colorstring(optional) Color to applied to the background
image_urlstring(optional, If image_id is supplied) url of the image to be used as background
image_idstring(optional, If image_url is supplied) id of the image asset to be used as background
positionJSONPosition of the graphics to be added to the image. The position is specified as a JSON object with x and y coordinates.
sizeJSONSize of the graphics to be added to the image. The size is specified as a JSON object with width and height.