API Reference Guide

Accelerate your website, enhance user experience, and boost your search rankings with our AI-powered image optimization tools
parameter
description
value type
possible values
(Default bolded)
No Results
Adjustment
parameter
Adjust brightness
description
integer
value type
-100 - 100 (0)
possible values
bri
parameter
Adjust contrast
description
integer
value type
-100 - 100 (0)
possible values
con
parameter
Adjust exposure
description
integer
value type
-100 - 100 (0)
possible values
exp
parameter
Adjust gamma
description
integer
value type
-100 - 100 (0)
possible values
gam
parameter
Adjust highlights
description
integer
value type
-100 - 100 (0)
possible values
high
Animation
parameter
Set frames per second
description
integer
value type
1 to 60
possible values
fps
parameter
Select frame range (e.g. 5-20)
description
integer range
value type
-
possible values
frame
parameter
Set gif quality (0 is highest)
description
integer
value type
-
possible values
gif-q
parameter
Keep only every Nth frame
description
integer
value type
-
possible values
interval
parameter
Set loop count
description
interger
value type
0 (infinite)
possible values
loop
Auto
parameter
Apply automatic enhancements
description
list
value type
compress | enhance | format | redeye
possible values
auto
Background Removal
parameter
Remove background
description
boolean
value type
false | true
possible values
bg-remove
Blending
parameter
Overlay colors, images, text
description
color | url | path
value type
-
possible values
blend
parameter
Set blend alignment
description
list
value type
bottom | center left | middle | right | top
possible values
blend-align
parameter
Set blend alpha
description
integer
value type
0 - 100
possible values
blend-alpha
parameter
Specify a blend color
description
color
value type
-
possible values
blend-color
parameter
Specify crop when blend-fit=crop
description
list
value type
bottom | faces | left | right | top
possible values
blend-crop
Border And Padding
parameter
Add a border
description
list (integer, color)
value type
-
possible values
border
parameter
Set bottom border
description
integer
value type
-
possible values
border-bottom
parameter
Set left border
description
integer
value type
-
possible values
border-left
parameter
Set outer radius of border
description
integer | list
value type
-
possible values
border-radius
parameter
Set inner radius of border
description
integer | list
value type
-
possible values
border-radius-inner
Color palette
parameter
Set how many colors to include in palette extraction
description
integer
value type
0 - 16 (6)
possible values
colors
parameter
Specifies output format for palette extraction
description
string
value type
css | json
possible values
palette
parameter
Sets CSS prefix for all classes in palette extraction
description
string
value type
image
possible values
prefix
Detection and Blur
parameter
blurs out faces detected
description
integer
value type
1-100
possible values
face-blur
parameter
Select face to crop to
description
integer
value type
-
possible values
face-index
parameter
Adjust padding around a selected face
description
number
value type
-
possible values
face-pad
parameter
pixelates faces detected
description
integer
value type
1-100
possible values
face-pixel
parameter
Specify face data to be included for fm=json
description
integer
value type
1
possible values
json-face-data
Fill
parameter
Specify color for any transparent image areas
description
color
value type
FFF
possible values
bg
parameter
Set how to fill additional space created by fit
description
string
value type
solid | blur
possible values
fill
parameter
Set fill color
description
color
value type
FFF
possible values
fill-color
parameter
creates linear gradient
description
color
value type
hex
parameter
creates radial gradient
description
color
value type
hex
Focal Point Crop
parameter
Display reticle identifying focal point location
description
boolean
value type
true
possible values
fp-debug
parameter
Set the relative horizontal value for focal point
description
unit_scalar
value type
0 - 1 (0.5)
possible values
fp-x
parameter
Set the relative vertical value for focal point
description
unit_scalar
value type
0 - 1 (0.5)
possible values
fp-y
parameter
Set the relative zoom value for focal point
description
number
value type
1 - 100
possible values
fp-z
Generative Imaging
parameter
Removes bg of images
description
string
value type
true
possible values
bg-remove
parameter
Replaces bg using text prompts
description
string
value type
prompt
possible values
bg-replace
parameter
Does not include prompt in newly generated bg
description
string
value type
prompt
possible values
bg-replace-neg-prompt
Version 2 - Last Updated: May 2025