Properties
Optional
ascii
ascii?: true | {
background?: string;
colored?: boolean;
foreground?: string;
reverse?: boolean;
size?: number;
}
Optional
blackwhite
blackwhite?: true | {
threshold: number;
}
Optional
blur
blur?: true | {
amount: number;
}
Optional
blur_faces
blur_
faces
?: { amount
?: number; blur
?: number; buffer
?: number; faces
?: string | number; maxsize
?: number; minsize
?: number; type
?: EShapeType; }
Type declaration
-
Optional
amount?: number
-
Optional
blur?: number
-
Optional
buffer?: number
-
Optional
faces?: string | number
-
Optional
maxsize?: number
-
Optional
minsize?: number
-
Optional
border
border?: true | {
background?: string;
color?: string;
width?: number;
}
Optional
cache
cache?: {
cache?: boolean;
expiry: number;
}
Type declaration
-
Optional
cache?: boolean
-
expiry: number
Optional
circle
circle?: true | {
background?: string;
}
Optional
collage
collage
?: { color
?: string; files
: [string]; fit
?: EFitOptions; height
?: number; margin
?: number; width
?: number; }
Type declaration
-
Optional
color?: string
-
files: [string]
-
-
Optional
height?: number
-
Optional
margin?: number
-
Optional
width?: number
Optional
compress
compress?: boolean
Optional
crop
crop?: {
dim: [number, number, number, number];
}
Type declaration
-
dim: [number, number, number, number]
Optional
crop_faces
crop_
faces
?: { buffer
?: number; faces
?: string | number; height
?: number; mode
?: ECropfacesType; width
?: number; }
Type declaration
-
Optional
buffer?: number
-
Optional
faces?: string | number
-
Optional
height?: number
-
-
Optional
width?: number
Optional
detect_faces
detect_faces?: true | {
color?: string;
export?: boolean;
maxsize?: number;
minsize?: number;
}
Optional
enchance
enchance?: boolean
Optional
flip
flip?: boolean
Optional
flop
flop?: boolean
Optional
imagesize
imagesize?: boolean
Optional
modulate
modulate?: true | {
brightness?: number;
hue?: number;
saturation?: number;
}
Optional
monochrome
monochrome?: boolean
Optional
negative
negative?: boolean
Optional
no_metadata
no_metadata?: boolean
Optional
oil_paint
oil_paint?: true | {
amount: number;
}
Optional
output
output?: {
background?: string;
colorspace?: string;
compress?: boolean;
density?: number;
docinfo?: boolean;
format: string;
page?: number;
pageformat?: string;
pageorientation?: string;
quality?: number;
secure?: boolean;
strip?: boolean;
}
Type declaration
-
Optional
background?: string
-
Optional
colorspace?: string
-
Optional
compress?: boolean
-
Optional
density?: number
-
Optional
docinfo?: boolean
-
format: string
-
Optional
page?: number
-
Optional
pageformat?: string
-
Optional
pageorientation?: string
-
Optional
quality?: number
-
Optional
secure?: boolean
-
Optional
strip?: boolean
Optional
partial_blur
partial_
blur
?: { amount
: number; blur
?: number; objects
?: [[number, number, number, number]]; type
?: EShapeType; }
Type declaration
-
amount: number
-
Optional
blur?: number
-
Optional
objects?: [[number, number, number, number]]
-
Optional
partial_pixelate
partial_
pixelate
?: { amount
?: number; blur
?: number; objects
?: [[number, number, number, number]]; type
?: EShapeType; }
Type declaration
-
Optional
amount?: number
-
Optional
blur?: number
-
Optional
objects?: [[number, number, number, number]]
-
Optional
pdfconvert
pdfconvert?: {
pageformat?: string;
pageorientation?: string;
pages?: (string | number)[];
}
Type declaration
-
Optional
pageformat?: string
-
Optional
pageorientation?: string
-
Optional
pages?: (string | number)[]
Optional
pdfinfo
pdfinfo?: true | {
colorinfo?: boolean;
}
Optional
pixelate
pixelate?: true | {
amount: number;
}
Optional
pixelate_faces
pixelate_
faces
?: { amount
?: number; blur
?: number; buffer
?: number; faces
?: string | number; maxsize
?: number; minsize
?: number; type
?: EShapeType; }
Type declaration
-
Optional
amount?: number
-
Optional
blur?: number
-
Optional
buffer?: number
-
Optional
faces?: string | number
-
Optional
maxsize?: number
-
Optional
minsize?: number
-
Optional
pjpg
pjpg?: {
metadata: boolean;
quality: number;
}
Type declaration
-
metadata: boolean
-
quality: number
Optional
polaroid
polaroid?: true | {
background?: string;
color?: string;
rotate?: number;
}
Optional
quality
quality?: {
value: number;
}
Optional
redeye
redeye?: boolean
Optional
resize
Type declaration
-
-
-
Optional
height?: number
-
Optional
width?: number
Optional
rotate
rotate?: {
background?: string;
color?: string;
deg: string | number;
}
Type declaration
-
Optional
background?: string
-
Optional
color?: string
-
deg: string | number
Optional
rounded_corners
rounded_corners?: true | {
background?: string;
blur?: number;
radius?: number;
}
Optional
security
security?: {
policy: string;
signature?: string;
}
Type declaration
-
policy: string
-
Optional
signature?: string
Optional
sepia
sepia?: true | {
tone: number;
}
Optional
sfw
sfw?: boolean
Optional
shadow
shadow?: true | {
background?: string;
blur?: number;
color?: string;
opacity?: number;
vector?: [number, number];
}
Optional
sharpen
sharpen?: true | {
amount: number;
}
Optional
smart_crop
smart_
crop
?: { height
: number; mode
?: ESmartCropMode; width
: number; }
Type declaration
-
height: number
-
-
width: number
Optional
store
store?: {
access?: string;
base64decode?: boolean;
container?: string;
filename?: string;
location?: string;
path?: string;
region?: string;
}
Type declaration
-
Optional
access?: string
-
Optional
base64decode?: boolean
-
Optional
container?: string
-
Optional
filename?: string
-
Optional
location?: string
-
Optional
path?: string
-
Optional
region?: string
Optional
tags
tags?: boolean
Optional
torn_edges
torn_edges?: true | {
background?: string;
spread?: [number, number];
}
Optional
video_convert
video_
convert
?: { access
?: EVideoAccess; aspect_mode
: EVideoAccessMode; audio_bitrate
?: number; audio_channels
?: number; audio_codec
?: EAudioTypes; audio_sample_rate
?: number; clip_length
?: string; clip_offset
?: string; container
?: string; extname
?: string; filename
?: string; force
?: boolean; fps
?: number; height
?: number; keyframe_interval
?: number; location
?: EVideoLocations; path
?: string; preset
?: EVideoTypes; title
?: string; two_pass
?: boolean; upscale
: boolean; video_bitrate
?: number; watermark_bottom
?: number; watermark_height
?: number; watermark_left
?: number; watermark_right
?: number; watermark_top
?: number; watermark_url
?: string; watermark_width
?: number; width
?: number; }
Type declaration
-
-
-
Optional
audio_bitrate?: number
-
Optional
audio_channels?: number
-
Optional
audio_codec?: EAudioTypes
-
Optional
audio_sample_rate?: number
-
Optional
clip_length?: string
-
Optional
clip_offset?: string
-
Optional
container?: string
-
Optional
extname?: string
-
Optional
filename?: string
-
Optional
force?: boolean
-
Optional
fps?: number
-
Optional
height?: number
-
Optional
keyframe_interval?: number
-
-
Optional
path?: string
-
-
Optional
title?: string
-
Optional
two_pass?: boolean
-
upscale: boolean
-
Optional
video_bitrate?: number
-
Optional
watermark_bottom?: number
-
Optional
watermark_height?: number
-
Optional
watermark_left?: number
-
Optional
watermark_right?: number
-
Optional
watermark_top?: number
-
Optional
watermark_url?: string
-
Optional
watermark_width?: number
-
Optional
width?: number
Optional
vignette
vignette
?: { amount
?: number; background
?: string; blurmode
?: EBlurMode; }
Type declaration
-
Optional
amount?: number
-
Optional
background?: string
-
Optional
blurmode?: EBlurMode
Optional
watermark
Type declaration
-
files: string
-
-
Optional
size?: number
See
https://www.filestack.com/docs/image-transformations