Filestack Documentation

Classes

Upload​Service

Service used for uploading files.

Client

Represents a client that allows communicating with the Filestack REST API.

Data​Response

This object represents a network data response.

Download​Response

This object represents a network download response.

File​Link

Represents a FileLink object.

JSONResponse

This object represents a network JSON response.

Policy

Represents a policy object.

Security

Represents a security object.

Storage​Options

Represents a set of storage options.

Transformable

Represents an Transformable object.

Upload​Options

Represents a set of options for uploading items to a given storage location.

Base​Operation

An operation that simplifies state flag handling and provides a method to finish a task delivering a result containing either a Success response or an Error response.

ASCIITransform

Converts the image to black and white.

AVTransform

Converts a video or audio to a different format, resolution, sample rate, etc.

Animate​Transform

Converts a set of images to a GIF file.

Auto​Image​Transform

Changes encoding of the image based on the user agent and therefore provides better compression and quality characteristics compared to their older JPEG and PNG counterparts.

Black​And​White​Transform

Converts the image to black and white.

Blur​Faces​Transform

Blur selected faces contained inside an image.

Blur​Transform

Applies a blurring effect to the image.

Border​Transform

Applies a border effect to the image.

Cache​Transform

Takes the file or files that are passed into it and compresses them into a zip file.

Circle​Transform

Applies a circle border effect to the image.

Collage​Transform

The collage task accepts an array of Filestack file handles, storage aliases, or external URLs. These files are appended in given order to the base file of the transformation URL. Altogther the base image and the passed files are the images that will comprise the collage. The order in which they are added dictates how the images will be arranged.

Collage​Transform​Collection

Class that is used for creating and sanitizing collection of file handles, storage aliases, or external urls.

Compress​Transform

Utilizes mozjpeg to offer improved compression for JPGS over the algorithm used for output=compress:true. It will not attempt to re-compress a previously compressed image.

Convert​Transform

Converts the image to a different format.

Copyright​Transform

Detects whether your image is copyright protected or not, and if it is protected, returns all types and related details such as purchase link, etc.

Crop​Faces​Transform

Crops selected faces contained inside an image.

Crop​Transform

Crops the image to a specified rectangle.

Detect​Faces​Transform

Detects the faces contained inside an image.

Document​Detection​Transform

Detects your document in the image, transforms it to fully fit the image, and preprocesses it using de-noising and distortion reduction in order to increase the accuracy of OCR engine in text extraction.

Enhance​Transform

Smartly analyzes a photo and performs color correction and other enhancements to improve the overall quality of the image.

Fallback​Transform

Returns default file if the source of the transformation does not work or the transformation fails.

Flip​Transform

Flips/mirrors the image vertically.

Flop​Transform

Flips/mirrors the image horizontally.

Image​Size​Transform

Returns the width and height of a given image.

Minify​CSSTransform

Minifies your CSS files.

Minify​JSTransform

Minifies your JavaScript files.

Modulate​Transform

Changes the image brightness, saturation and hue.

Monochrome​Transform

Converts the image to monochrome.

Negative​Transform

Returns a negative image by portraying the lightest area as the darkest and the darkest areas as the lightest.

NoMetadata​Transform

Removes any metadata embedded in an image.

OCRTransform

Detects both printed and handwritten texts in images. The result follows the standard JSON format containing all of the details regarding detected text areas, lines, and words.

Oil​Paint​Transform

Change the image to look like it was oil painted.

PDFConvert​Transform

Converts a PDF to a specific orientation, page format, and, optionally, extracts specific pages.

PDFInfo​Transform

Gets information about a PDF document.

PDFMonochrome​Transform

Converts a PDF to black and white version.

Partial​Blur​Transform

Changes image brightness, saturation and hue.

Partial​Pixelate​Transform

Changes image brightness, saturation and hue.

Pixelate​Faces​Transform

Pixelates selected faces contained inside an image.

Pixelate​Transform

Pixelates the image.

Polaroid​Transform

Applies a Polaroid border effect to the image.

Progressive​JPEGTransform

Converts an image to progressive JPEG.

Quality​Transform

Sets the quality of your JPG or WEBP image without the danger of possibly generating a larger file.

Red​Eye​Removal​Transform

Removes the red eye effect from photos.

Resize​Transform

Resizes the image to a given width and height using a particular fit and alignment mode.

Rotate​Transform

Rotates an image in a range from 0 to 359 degrees or based on Exif information.

Rounded​Corners​Transform

Rounds the image's corners.

Secure​For​Work​Transform

Returns whether the image if safe to display.

Sepia​Transform

Converts the image to sepia color.

Shadow​Transform

Applies a shadow border effect to the image.

Sharpen​Transform

Applies a sharpening effect to the image.

Tags​Transform

Analyzes and returns any tags associated to this image.

Torn​Edges​Transform

Applies a torn edge border effect to the image.

Transform

:nodoc:

URLScreenshot​Transform

Captures content of given URL. The URL screenshot task will not work for content that is located in areas that require you to login. If the content is not publicly visible, then it will not be captured.

Upscale​Transform

Upscales the image making it two times bigger.

Vignette​Transform

Applies a vignette border effect to the image.

Watermark​Transform

Watermarks the image by overlaying another image on top of your main image.

Zip​Transform

Takes the file or files that are passed into it and compresses them into a zip file.

Structures

Metadata​Options

Represents a metadata option.

Policy​Call

Represents a policy call type.

Transform​Position

Represents an image transform position type.

Enumerations

Error

:nodoc:

Storage​Access

Represents the storage access to a file.

Storage​Location

Represents a cloud storage location type.

Transform​Align

Represents an image transform alignment type.

Transform​Aspect​Mode

Represents an image transform aspect type.

Transform​Blur​Mode

Represents an image transform blur type.

Transform​Color​Space

Represents an image transform color space type.

Transform​Crop​Mode

Represents an image transform crop type.

Transform​Enhance​Preset

Represents an enhance transformation preset.

Transform​Filetype

Represents an image transform noise reduction type.

Transform​Fit

Represents an image transform fit type.

Transform​Noise​Mode

Represents an image transform noise reduction type.

Transform​Page​Format

Represents an image transform page format type.

Transform​Page​Orientation

Represents an image transform page orientation type.

Transform​Shape​Type

Represents an image transform pixelate faces type.

Transform​Style​Mode

Represents an image transform style type.

Upload​State

Represents the current state of an upload.

Protocols

Cancellable

The protocol any cancellable process must conform to.

Deferred​Add

The protocol any uploader that supports deferred adds must conform to.

Monitorizable

The protocol any monitorizable process must conform to.

Startable

The protocol any startable process must conform to.

Uploadable

The protocol any uploadables must conform to.

Uploader

The protocol any uploader must conform to.

Typealiases

Upload​Status
Network​Data​Response
Network​Download​Response
Network​JSONResponse

Extensions

Data
URL