Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
filterType
enum<string>

Filter

Available options:
blur,
hueRotate,
saturate,
luminanceToAlpha,
turbulence,
dropShadow,
emboss
filterId
string

Filter ID

blurStdDev
number

Blur amount (stdDeviation, px)

Required range: 0 <= x <= 30
hueRotateAngle
number

Angle (deg)

Required range: 0 <= x <= 360
saturateValue
number

Amount (0 = grayscale, 1 = original)

Required range: 0 <= x <= 3
turbType
enum<string>

Noise type

Available options:
turbulence,
fractalNoise
turbBaseFrequency
number

Base frequency

Required range: 0.005 <= x <= 0.5
turbOctaves
number

Octaves

Required range: 1 <= x <= 10
turbScale
number

Displacement scale

Required range: 0 <= x <= 200
shadowDx
number

Offset X (px)

Required range: -50 <= x <= 50
shadowDy
number

Offset Y (px)

Required range: -50 <= x <= 50
shadowBlur
number

Blur radius (px)

Required range: 0 <= x <= 50
shadowColor
string

Shadow color

shadowOpacity
number

Shadow opacity

Required range: 0 <= x <= 1
embossStyle
enum<string>

Kernel

Available options:
emboss,
engrave,
sharpen,
edge
previewTarget
enum<string>

Preview on

Available options:
text,
shapes,
image
image
string

Image

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.