Overview
All stored files in your application are available over the Filestack CDN, and each file’s URL can be modified with processing “tasks” that modify the requested resource. Each task has its own set of parameters that are documented on this page. Our API Clients provide programmatic access to construct these transformation URLs.
Processing tasks can be chained together in the same URL by separating them with forward slashes. All tasks follow the structure of TASK=option:value
, where option:value
pairs are comma separated.
You may make processing requests with either a Filestack handle, a Filestack storage alias, or a public URL. If using a URL or storage alias, your API key must be prepended to the task chain, like this:
You may chain together as many tasks as you like, presuming their types logically follow. Tasks are executed in the order they appear in the URL, and are separated by forward slashes.
This resizes the height of the image to 200 pixels (while preserving aspect ratio), and then modifies the hue of the image.
Security
If your account has security enabled, a valid policy and signature will be required for any and all processing requests. The processing engine accepts security parameters as a URL task:
Please see our security documentation for more information regarding the generation of policies and signatures.
Legend
All task parameters listed here follow this pattern. Array types are presented as ordered lists of their respective types. Required fields are marked by an asterisk *.
Name (Alias) |
Control Tasks
Cache
cache=expiry:3600
Specify amount of time for how long the file should be cached in our CDN. For example, cache=expiry:31536000
will set the cache duration for 1 year. You can also use cache=expiry:max
and the same value will be set for the cache headers: “Cache-Control:public, max-age=31536000”. The cache can be set to false
to ensure that you always receive a newly converted file. This setting is only recommended for testing purposes because every time a URL using cache=false
loads, it will count against your conversion quota.
Parameters
false (f) | |
expiry (e) |
Store
store
Store the result of this transformation into your storage. By default, transformations are stored in temporary storage and cached for 30 days. Storing files can ensure that you don’t incur extra transformations when the cache expires every 30 days. It also allows you to create new handles from transformed URLs.
A request to a URL which contains this task will return a JSON response. Example:
{
"container": "my-bucket",
"filename": "272262.png",
"key": "brPb11lRQR67XKxC9aUQ-272262.png",
"size": 4585441,
"type": "image/png",
"url": "https://cdn.filestackcontent.com/feAWPKHgR6SnJMRzsKVP"
}
Parameters
filename (f) | |
location (l) |
one of: |
path (p) | |
container (c) | |
region (r) |
one of: |
access (a) |
one of: |
base64decode (b) |
Fallback
fallback=handle:<handle>,cache:<cache>
Returns default
file if the source of the transformation does not work or the transformation fails.
PARAMETER | VALUE |
---|---|
handle | HANDLE of the file that should be returned. |
cache | Number of seconds fallback response should be cached in CDN. |
If you are using fallback handle that belongs to different application than the one which runs transformation (APIKEY) and it is secured with security policy, appropriate signature and policy with read
call should be used:
/fallback=handle:"<handle>?policy=<policy>&signature=<signature>",cache:10/
.
You can read more about security policies here.
Examples
Request without fallback. DOC to DOC conversion will fail:
https://cdn.filestackcontent.com/<apikey>/output=f:doc/http://www.snee.com/xml/xslt/sample.doc
Fallback:
https://cdn.filestackcontent.com/<apikey>/output=f:doc/fallback=handle:grKLLdxJQgm3VU3dRWW6/http://www.snee.com/xml/xslt/sample.doc
Fallback with 10 second cache:
https://cdn.filestackcontent.com/<apikey>/output=f:doc/fallback=handle:grKLLdxJQgm3VU3dRWW6,cache:10/http://www.snee.com/xml/xslt/sample.doc
Fallback with security (if fallback handle belongs to the same application)
https://cdn.filestackcontent.com/<apikey>/security=policy:<policy>,signature:<signature>/output=f:doc/fallback=handle:grKLLdxJQgm3VU3dRWW6/http://www.snee.com/xml/xslt/sample.doc
Fallback to secured handle (only if it’s from other application than the source of the transformation):
https://cdn.filestackcontent.com/<apikey>/output=f:doc/fallback=handle:"grKLLdxJQgm3VU3dRWW6?policy=<policy>&signature=<signature>"/http://www.snee.com/xml/xslt/sample.doc
Content Disposition
content=type:<type>,filename:<filename>
Sets Content-Disposition
header for given file.
PARAMETER | VALUE | DESCRIPTION |
---|---|---|
type (t) | stringinline | One of: inline default value, indicates that file can be displayed inside the web page, or as the web page attachment indicates that file should be downloaded; most browsers presenting a “Save as” dialog, prefilled with the value of the filename parameters if present. |
filename (f) | string | Filename to use with attachment type. |
Examples
https://cdn.filestackcontent.com/<apikey>/content=t:attachment,f:"sample.jpg"/<handle>
Image Restrictions
The maximum accepted image resolution is 100,000,000 pixels
. For example it can either be 10,000px x 10,000px
or 5,000px x 20,000px
.
Filestack will also not convert an image that is larger than 256 MB
. Please contact us if you require the ability to process larger files.
Image Transformations
Image Size
imagesize
You can use the imagesize task to get information about width and height of the given image, for example:
https://cdn.filestackcontent.com/imagesize/HANDLE
Imagesize GET request will return data as JSON, for example:
{"height":1253,"width":1080}
Resize
resize=height:200
The resizing feature comprises two main functions: manipulating the width and height of an image, and changing the fit and alignment of the image. Either width or height is required.
Parameters
width* (w) | |
height* (h) | |
fit (f) |
one of: |
align (a) |
one of: or array of 2 strings:
|
Crop
crop=dim:[x,y,width,height]
Crop images by entering coordinates and crop dimensions. The X and Y coordinates start from [0,0] and correspond to the top left-hand corner of the image. The width and height parameters dictate the size in pixels of the cropping rectangle. If the crop area extends outside the frame of the image, you will only receive back the part of the image that is within the crop area.
Parameters
dim* (d) |
array of 4 integers:
|
Rotate
rotate=deg:180
You can rotate your image in a range clockwise from 0 degrees (no rotation) to 359 (nearly all the way around). Specifying “exif” for the degree parameter will auto-detect EXIF orientation and apply the rotation.
Parameters
deg (d) |
one of: or |
exif (e) | |
background (b) |
Flip
flip
This task flips the image in the vertical direction. Flip requires no additional parameters.
Flop
flop
This task flops the image in the horizontal direction. Flop requires no additional parameters.
Watermark
watermark=position:[middle, center]
You can add watermarks by overlaying one image on top of another. The size of the overlayed image is a percentage of its original size.
Parameters
file* (f) | |
size (s) | |
position (p) |
one of: or array of 2 strings:
|
Compress
compress
Filestack offers a standalone task specifically for compression. It utilizes mozjpeg to offer improved compression for JPG files over the algorithm used for output=compress:true. It will not attempt to re-compress a previously compressed image. Compress will only work with PNG and JPG files. If any other format is passed in, it will return an unchanged image. For the best results, compress should be the last task in your transformation chain.
Parameters
metadata (m) |
Progressive JPEG
pjpg
Convert an image to progressive JPEG. This is ideal for large images that will be displayed while downloading over a slow connection, allowing a reasonable preview after receiving only a portion of the data. However, support for progressive JPEGs is not universal. When progressive JPEGs are received by programs that do not support them (such as versions of Internet Explorer before Windows 7) the software displays the image only after it has been completely downloaded.
Parameters
quality (q) | |
metadata (m) |
Quality
quality
Set the quality of your JPG or WEBP images without the danger of possibly generating a larger file. This is great for reducing the file size of your image before running it through the compress task. Quality is a standalone task which is separate from the quality parameter available in the output task, and it will never increase the size of a file.
Parameters
value* (v) |
Strip Metadata
no_metadata
Remove any embedded metadata from an image file.
Image Enhancements
These powerful image enhancements are available for Pro plans and higher. See our pricing page for more info.
Upscale
upscale
Parameters
noise (n) |
one of: |
upscale (u) | |
style (s) |
one of: |
Enhance
enhance
This task smartly analyzes a photo and performs color correction and other enhancements to improve the overall quality of the image.
Automatic image enhancement
https://cdn.filestackcontent.com/enhance/HANDLE
In standard version enhance requires no additional parameters. If you have presets enabled in your plan you will have access to additional preset
parameter.
enhance=preset:<preset>
Available presets are listed in the table below:
PRESET | DESSCSRIPTION |
---|---|
auto | This parameter automatically chooses a preset that does best enhancement to a photo. |
vivid | This preset gives more depth and brightness to a photo. |
beautify | This preset works wonders on portraits and shots of people. It automatically scans each face in the photo and adjusts how much corrections to apply to each face. |
beautify_plus | It is similar to beautify , but it applies stronger corrections and uses larger set of possible modifications. |
fix_dark | This setting will do a terrific job on extremely underexposed photos or photos where a dark subject is in front of a very bright background. By turning off the contrast, maximum detail is retrieved from the shadow areas without blowing out the bright areas. |
fix_noise | This setting automatically detects noise, and if detected, applies powerful noise removal to remove any grains from your photos while preserving details. Noise is automatically detected and applied depending on the ISO level and your camera make/model, and will therefore vary per photo. |
fix_tint | Use this setting to remove abnormal tint (yellow, blue, green, etc.) from your photos. Abnormal tint occurs where the camera’s sensor picked up excess green from fluorescent lights, or excess red from the infrared heat of a person in the image, or excess blue from ultraviolet, or excess yellow from tungsten lights. |
outdoor | This preset optimizes your landscape photographs with more color vibrancy. The contrast is adjusted to reveal slightly more detail in the shadow areas. |
fireworks | This preset applies correction for dark night sky and sets off excess colors from fireworks. |
Below you can see example usage of the enhance=preset:fix_noise
preset:
You can find more examples in our tutorial.
Examples
Image enhancement with
fix_dark
preset:https://cdn.filestackcontent.com/enhance=preset:fix_dark/HANDLE
Chain enhance with other tasks:
https://cdn.filestackcontent.com/resize=w:500/enhance=preset:beautify/HANDLE
Red Eye Removal
redeye
This task removes the red eye effect from photos. The redeye task requires no additional parameters.
Image Borders and Effects
Rounded Corners
rounded_corners=blur:0.3
Parameters
radius (r) |
one of: or |
blur (l) | |
background (b) |
Vignette
vignette=amount:20
Parameters
amount (a) | |
blurmode (m) |
one of: |
background (b) |
Polaroid
polaroid
Parameters
rotate (r) | |
background (b) | |
color (c) |
Torn Edges
torn_edges=spread:[1,10]
Parameters
spread (s) |
array of 2 integers:
|
background (b) |
Shadow
shadow=opacity:60,vector:[4,4]
Parameters
blur (l) | |
opacity (o) | |
vector (v) |
array of 2 integers:
|
color (c) | |
background (b) |
Circle
circle
Parameters
background (b) |
Border
border=width:2
Parameters
color (c) | |
background (b) | |
width (w) |
Image Filters
Sharpen
sharpen=amount:2
Parameters
amount (a) |
Blur
blur=amount:2
Parameters
amount (a) |
Monochrome
monochrome
Black and White
blackwhite=threshold:50
Parameters
threshold (t) |
Sepia
sepia=tone:80
Parameters
tone (t) |
Pixelate
pixelate=amount:2
Parameters
amount (a) |
Oil Paint
oil_paint=amount:2
Parameters
amount (a) |
Negative
negative
The image returned by this transformation creates a negative image by portraying the lightest area as the darkest and the darkest areas as the lightest. The negative task requires no additional parameters.
Modulate
modulate=hue:155
Parameters
brightness (b) | |
saturation (s) | |
hue (h) |
Partial Pixelate
partial_pixelate=objects:[[x,y,width,height],[x,y,width,height]]
Parameters
objects* (o) |
array of: array of 4 integers: |
amount (a) | |
blur (l) | |
type (t) |
one of: |
Partial Blur
partial_blur=objects:[[x,y,width,height],[x,y,width,height]]
Parameters
objects* (o) |
array of: array of 4 integers: |
amount (a) | |
blur (l) | |
type (t) |
one of: |
Facial Detection
Detect Faces
detect_faces
The minsize
and maxsize
parameters are used to weed out objects that most likely are not faces. This can be an integer or a float in a range from 0.01 to 10000. The default value is 0.35. If the value is larger than 1, it is used as the expected minimum/maximum size of face objects in pixels. So for example if the value is set to 200, then the smallest/largest face object it will detect is 200x200 pixels. If the value that is set is less than 1, e.g. 0.3, then it filters out all face objects it detects that are smaller/larger than the middle/average object size by 30%.
For example, this means that if a set of 3 objects are detected that are (size in pixels) [‘100x100’, ‘200x200’, ‘300x300’], then setting minsize to 0.3 will result in a calculation where the middle object size 200 is used: 200-0.30*200=140 and all objects smaller than 140x140 would be eliminated.
Setting export:true
will export all face objects to a JSON object:
[
{
"x": 642,
"y": 298,
"width": 137,
"height": 137,
"id": 1
},
{
"x": 446,
"y": 731,
"width": 138,
"height": 138,
"id": 2
}
]
Parameters
maxsize (x) | |
minsize (n) | |
color (c) | |
export (e) |
Crop Faces
crop_faces
mode:thumb
- adds a buffer around the face object by default. Part of the image inside the buffer is always resized to the desired dimensions (w & h parameters).mode:crop
- ignores the buffer around the face object.mode:fill
- works in a similar manner to thumb mode, except that while thumb mode will always crop an image to fit in the whole face object while still trying to respect width and height transformations, fill mode will prioritze width and height parameters over displaying the whole face object.
The faces
parameter can be a single face object, an array of face objects, or you can use faces:all
to choose all the detected face objects. This parameter governs the faces you want included in your crop.
Parameters
width (w) | |
height (h) | |
faces (f) |
one of: or or array of: |
maxsize (x) | |
minsize (n) | |
buffer (b) | |
mode (m) |
one of: |
Pixelate Faces
pixelate_faces
Parameters
faces (f) |
one of: or or array of: |
maxsize (x) | |
minsize (n) | |
buffer (b) | |
amount (a) | |
blur (l) | |
type (t) |
one of: |
Blur Faces
blur_faces
Parameters
faces (f) |
one of: or or array of: |
maxsize (x) | |
minsize (n) | |
buffer (b) | |
amount (a) | |
blur (l) | |
type (t) |
one of: |
File Conversions
File Type
output=format:FILE_TYPE
See our File Conversion Matrix for info on all supported conversions.
density
will adjust the resolution when converting documents like PowerPoint, PDF, AI and EPS files to image formats like JPG or PNG. Higher density values mean higher resolutions, which will improve the image quality.
docinfo
can be used to get information about a document, such as the number of pages and the dimensions of the file. This information is delivered as a JSON object, for example:
{"numpages":41,"dimensions":{"width":538,"height":718}}
strip
can be used to remove embedded file metadata.
secure
applies to conversions of HTML and SVG sources. When the secure parameter is set to true, the HTML or SVG file will be stripped of any insecure tags (HTML sanitization).
Parameters
format (f) |
one of: |
page (p) | |
density (d) | |
compress (c) | |
quality (q) |
one of: or |
secure (s) | |
docinfo (i) | |
strip (t) | |
colorspace (o) |
one of: |
background (b) | |
pageformat (a) |
one of: |
pageorientation (r) |
one of: |
Auto Image Conversion
auto_image
This task automatically 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.
Currently Filestack supports automatic conversion to WebP
and JPEG XR
.
WebP
is natively supported in Google Chrome, Firefox, Edge, Opera, and by many other tools and software libraries.
For example this 1.42 MB JPEG image, after applying resize and compress tasks would have 48.45 KB:
https://cdn.filestackcontent.com/resize=w:300/compress/wSPGjTiQtuImifba6aAQ
JPEG 48.45 KB
If you are using auto_image
task and one of the supported browsers you should see that it’s delivered in a WebP
format and it’s size is 44.84 KB.
https://cdn.filestackcontent.com/resize=w:300/auto_image/compress/wSPGjTiQtuImifba6aAQ
WebP 44.84 KB
You can read more about benefits of using WebP
at https://developers.google.com/speed/webp/.
To see the current browser support for each supported next-gen format, check out the entries below:
Examples
Automatic image encoding:
https://cdn.filestackcontent.com/auto_image/HANDLE
Chaining with other tasks:
https://cdn.filestackcontent.com/auto_image/resize=width:400,fit:max/compress/HANDLE
Animate (Images to GIF)
animate
Animate task converts set of images to a GIF file.
PARAMETER | VALUE | DESCRIPTION |
---|---|---|
delay | integer1000 | Defines a delay between frames (in milliseconds). |
loop | integer0 | Defines how many times images should be displayed,0 = loop forever . |
width | integermax | Output animation width. By default it’s the width of the largest image. |
height | integermax | Output animation height. By default it’s the height of the largest image. |
fit | stringclip | Possible values: clip scale crop |
align | string|array(2)center | Possible values: top right bottom left center middle or array of 2 strings: 1. one of: top bottom middle 2. one of: left right center |
background | stringtransparent | For example: transparent, black, white, red . |
Examples
Animate images every second in a loop and produce 200x300 GIF file:
https://cdn.filestackcontent.com/animate=fit:scale,width:200,height:300/[HANDLE1,HANDLE2,HANDLE3,HANDLE4,HANDLE5]

Limitations
NAME | VALUE |
---|---|
Maximum file size of single image | 256 MB |
Maximum width of single image | 1800 px |
Maximum height of single image | 1800 px |
Allowed file formats | JPEG PNG SVG BMP TIFF GIF |
Collage
collage=files:[0ZgN5BtJTfmI1O3Rxhce]
The collage task accepts an array of Filestack file handles, storage aliases, or external urls. These files are appended in 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 appear in the array dictates how the images will be arranged.
Both width
and height
are required. The images passed to this task will be resized using fit:clip
(resize) so that the output image is close to the specified dimension parameters. The width parameter takes precedence over the height parameter.
Parameters
files* (f) | |
margin (m) | |
width* (w) | |
height* (h) | |
color (c) | |
fit (i) |
one of: |
autorotate (a) |
ASCII
ascii
Take any image file and turn it into an HTML file of ASCII Art.
reverse
reverses the character set used to generate the ASCII output. Works well with dark backgrounds. Requires color:true
.
size
specifies the size of the returned file as a percentage of the original.
Parameters
background (b) | |
foreground (f) | |
colored (c) | |
size (s) | |
reverse (r) |
URL Screenshot
urlscreenshot
Note: This only works with external URLs, following the format:
https://cdn.filestackcontent.com/APIKEY/urlscreenshot/FULL_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.
Parameters
agent (a) |
one of: |
width (w) | |
height (h) | |
mode (m) |
one of: |
delay (d) | |
orientation (o) |
one of: |
device (e) |
ZIP
zip
This task takes the file or files that are passed into it and compresses them into a zip file. You can pass in a solitary Filestack handle, a single external url, a Filestack storage alias, or an array of handles and urls to be zipped. The zip task has no additional parameters.
Minify JS
minify_js
This tasks minifies your JavaScript files.
PARAMETER | VALUE |
---|---|
gzip | booleantrue |
use_babel_polyfill | booleantrue |
keep_fn_name | booleantrue |
keep_class_name | booleantrue |
mangle | booleantrue |
merge_vars | booleantrue |
remove_console | booleantrue |
remove_undefined | booleantrue |
targets | booleantrue |
Examples
Minify JavaScript file from external source
https://cdn.filestackcontent.com/API_KEY/minify_js/https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.js
Minify CSS
minify_css
This tasks minifies your CSS files.
PARAMETER | VALUE | DESCRIPTION |
---|---|---|
level | integer1 | Minification level. |
gzip | booleanfalse | Compress file and add content encoding gzip header. |
Examples
Minify CSS file from external source
https://cdn.filestackcontent.com/API_KEY/minify_css/https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.css
Document Transformations
PDF Info
Get information about PDF document. This task returns following information:
pdfinfo=colorinfo:<colorinfo>
PARAMETER | VALUE |
---|---|
colorinfo | booleanfalse |
Response
{
"colorinfo": [
{
"c": 0.1442,
"k": 0.61787,
"m": 0.18234,
"y": 0.19159
},
{
"c": 0.18357,
"k": 0.44799,
"m": 0.30939,
"y": 0.27883
}
],
"created": "2017-07-13T11:59:59-05",
"encrypted": false,
"hasform": false,
"hasjavascript": false,
"isgrayscale": false,
"isoptimized": true,
"istagged": true,
"pages": 2,
"pagesize": {
"height": 792,
"paper": "Letter",
"width": 612
},
"pdfversion": "1.7",
"protected": false,
"updated": "2017-07-13T12:00:01-05"
}
PARAMETER | DESCRIPTION |
---|---|
created | When the document was originally created. |
updated | When the document was updated. |
pdfversion | PDF document version |
protected | Determines if the document is password protected. |
encrypted | Determines if the document is encrypted. |
istagged | Determines if there is any PDF Tag available in the document. |
isoptimized | Determines if the media in the document are optimized. |
isgrayscale | This is true if all the pages of the document are grayscale. |
hasform | Determines if the document has interactive forms. |
hasjavascript | Determines if the document has embedded JavaScript code. |
pages | Number of pages. |
pagesize | Width, height and papersize of the document. |
colorinfo | Color information (CMYK) about each page of the document. |
Examples
Get color information:
https://cdn.filestackcontent.com/output=f:pdf/pdfinfo=colorinfo:true/HANDLE
PDF Conversions
Converting PDF to specific orientation, pageformat and specific pages.
pdfconvert=pageorientation:<pageorientation>,pageformat:<pageformat>,pages:<pages>
PARAMETER | VALUE |
---|---|
pageorientation | “landscape” or “portrait” |
pageformat | “a2” “a3” “a4” “a5” “b4” “b5” “letter” “legal” “tabloid” |
pages | any combination of pages or ranges, for example [1,3,6] or [3-5,6-7] or [1-3,5] |
Examples
Convert to specific orientation, format:
https://cdn.filestackcontent.com/output=f:pdf/pdfconvert=pageorientation:landscape,pageformat:a3/HANDLE
With specific pages.
https://cdn.filestackcontent.com/output=f:pdf/pdfconvert=pageorientation:landscape,pageformat:a3,pages:[2,3,4]/HANDLE
PDF Monochrome
Convert PDF to black and white version.
monochrome
Examples
Convert some of the PDF pages to specific orientation and format in black and white:
https://cdn.filestackcontent.com/output=f:pdf/pdfconvert=pageorientation:landscape,pageformat:a3,pages:[2,3,4]/monochrome/HANDLE
Audio and Video
video_convert
Most tasks return content directly, but A/V tasks return job metadata because they run asynchronously. When requesting an audio or video conversion:
https://cdn.filestackcontent.com/video_convert=height:260,width:350/HANDLE
You will receieve an initial JSON response:
{
"data":{},
"metadata": {
"result":{},
"source":{}
},
"status":"started",
"timestamp":"1522783969",
"uuid":"5c0f33cc9c464e16592b7a01f6f8f5c1"
}
Polling the URL will eventually yield a response with populated results. If you would like to receive this asynchronously upon completion (no polling), please refer to our webhooks documentation.
Completed A/V response:
{
"data":{
"thumb":"https://cdn.filestackcontent.com/HANDLE",
"thumb100x100":"https://process.filestackapi.com/APIKEY/resize=w:100,h:100,f:crop/output=f:jpg,q:66/https://cdn.filestackcontent.com/HANDLE",
"thumb200x200":"https://process.filestackapi.com/APIKEY/resize=w:200,h:200,f:crop/output=f:jpg,q:66/https://cdn.filestackcontent.com/HANDLE",
"thumb300x300":"https://process.filestackapi.com/APIKEY/resize=w:300,h:300,f:crop/output=f:jpg,q:66/https://cdn.filestackcontent.com/HANDLE",
"url":"https://cdn.filestackcontent.com/HANDLE"
},
"metadata": {
"result": {
"audio_bitrate":128,
"audio_channels":1,
"audio_codec":"aac",
"audio_sample_rate":44100,
"created_at":"2018/04/03 20:15:50 +0000",
"duration":5615,
"encoding_progress":100,
"encoding_time":2,
"extname":".mp4",
"file_size":150791,
"fps":30,
"height":260,
"mime_type":"video/mp4",
"started_encoding_at":"2018/04/03 20:15:51 +0000",
"updated_at":"2018/04/03 20:15:55 +0000",
"video_bitrate":81,
"video_codec":"h264",
"width":350
},
"source": {
"audio_bitrate":83,
"audio_channels":1,
"audio_codec":"aac",
"audio_sample_rate":48000,
"created_at":"2018/04/03 20:15:50 +0000",
"duration":5568,
"extname":".mp4",
"file_size":383631,
"fps":30,
"height":320,
"mime_type":"video/mp4",
"updated_at":"2018/04/03 20:15:55 +0000",
"video_bitrate":465,
"video_codec":"h264",
"width":560
}
},
"status":"completed",
"timestamp":"1522786635",
"uuid":"UUID"
}
Supported Formats
- h264
- h264.hi
- webm
- webm.hi
- ogg
- ogg.hi
- hls.variant
- mp3
- oga
- m4a
- aac
- hls.variant.audio
Note: When using the HLS preset, many files will be generated in your storage container and we will return you a special processing engine link to the playlist file:
https://cdn.filestackcontent.com/video_playlist/HANDLE
The video_playlist task generates the playlist dynamically so that all the segments in the playlist can have the same security policy and signature applied in the request if security is enabled for your API key.
Note: Each second of audio or video transcoding counts as 2 transformations. Please take your plan’s conversion limits into account before processing any audio, as you can quickly exceed your plan’s limits and incur overages.
You can restart a failed or pending transcoding by specifying force:true
.
Parameters
width (w) | |
height (h) | |
preset (p) | |
force | |
title (t) | |
extname (e) | |
upscale (u) | |
aspect_mode (a) |
one of: |
audio_sample_rate (r) | |
two_pass (s) | |
video_bitrate (b) | |
fps (f) | |
keyframe_interval (k) | |
audio_bitrate | |
audio_channels (c) | |
clip_length (l) | |
clip_offset (o) | |
watermark_url | |
watermark_top | |
watermark_right | |
watermark_bottom | |
watermark_left | |
frame_count | |
filename | |
location |
one of: |
path | |
container | |
access |
one of: |
Video Playlist Parameters
segment (s) |
Color Options
Many of the Filestack conversion options allow you to set a color for the background, border or other parameter. The following is a list of defined color options. You can set any color you want using the hexadecimal (or shortened hexadecimal) code, but there is a set list of defined color words Filestack accepts.
Name | Color | Hex |
---|---|---|
aliceblue |
F0F8FFFF |
|
antiquewhite |
FAEBD7FF |
|
aqua |
00FFFFFF |
|
aquamarine |
7FFFD4FF |
|
azure |
F0FFFFFF |
|
beige |
F5F5DCFF |
|
bisque |
FFE4C4FF |
|
black |
000000FF |
|
blanchedalmond |
FFEBCDFF |
|
blue |
0000FFFF |
|
blueviolet |
8A2BE2FF |
|
brown |
A52A2AFF |
|
burlywood |
DEB887FF |
|
cadetblue |
5F9EA0FF |
|
chartreuse |
7FFF00FF |
|
chocolate |
D2691EFF |
|
coral |
FF7F50FF |
|
cornflowerblue |
6495EDFF |
|
cornsilk |
FFF8DCFF |
|
crimson |
DC143CFF |
|
cyan |
00FFFFFF |
|
darkblue |
00008BFF |
|
darkcyan |
008B8BFF |
|
darkgoldenrod |
B8860BFF |
|
darkgray |
A9A9A9FF |
|
darkgreen |
006400FF |
|
darkgrey |
A9A9A9FF |
|
darkkhaki |
BDB76BFF |
|
darkmagenta |
8B008BFF |
|
darkolivegreen |
556B2FFF |
|
darkorange |
FF8C00FF |
|
darkorchid |
9932CCFF |
|
darkred |
8B0000FF |
|
darksalmon |
E9967AFF |
|
darkseagreen |
8FBC8FFF |
|
darkslateblue |
483D8BFF |
|
darkslategray |
2F4F4FFF |
|
darkslategrey |
2F4F4FFF |
|
darkturquoise |
00CED1FF |
|
darkviolet |
9400D3FF |
|
deeppink |
FF1493FF |
|
deepskyblue |
00BFFFFF |
|
dimgray |
696969FF |
|
dimgrey |
696969FF |
|
dodgerblue |
1E90FFFF |
|
firebrick |
B22222FF |
|
floralwhite |
FFFAF0FF |
|
forestgreen |
228B22FF |
|
fractal |
808080FF |
|
fuchsia |
FF00FFFF |
|
gainsboro |
DCDCDCFF |
|
ghostwhite |
F8F8FFFF |
|
gold |
FFD700FF |
|
goldenrod |
DAA520FF |
|
gray0 |
000000FF |
|
gray1 |
030303FF |
|
gray2 |
050505FF |
|
gray3 |
080808FF |
|
gray4 |
0A0A0AFF |
|
gray5 |
0D0D0DFF |
|
gray6 |
0F0F0FFF |
|
gray7 |
121212FF |
|
gray8 |
141414FF |
|
gray9 |
171717FF |
|
gray10 |
1A1A1AFF |
|
gray11 |
1C1C1CFF |
|
gray12 |
1F1F1FFF |
|
gray13 |
212121FF |
|
gray14 |
242424FF |
|
gray15 |
262626FF |
|
gray16 |
292929FF |
|
gray17 |
2B2B2BFF |
|
gray18 |
2E2E2EFF |
|
gray19 |
303030FF |
|
gray20 |
333333FF |
|
gray21 |
363636FF |
|
gray22 |
383838FF |
|
gray23 |
3B3B3BFF |
|
gray24 |
3D3D3DFF |
|
gray25 |
404040FF |
|
gray26 |
424242FF |
|
gray27 |
454545FF |
|
gray28 |
474747FF |
|
gray29 |
4A4A4AFF |
|
gray30 |
4D4D4DFF |
|
gray31 |
4F4F4FFF |
|
gray32 |
525252FF |
|
gray33 |
545454FF |
|
gray34 |
575757FF |
|
gray35 |
595959FF |
|
gray36 |
5C5C5CFF |
|
gray37 |
5E5E5EFF |
|
gray38 |
616161FF |
|
gray39 |
636363FF |
|
gray40 |
666666FF |
|
gray41 |
696969FF |
|
gray42 |
6B6B6BFF |
|
gray43 |
6E6E6EFF |
|
gray44 |
707070FF |
|
gray45 |
737373FF |
|
gray46 |
757575FF |
|
gray47 |
787878FF |
|
gray48 |
7A7A7AFF |
|
gray49 |
7D7D7DFF |
|
gray50 |
7F7F7FFF |
|
gray51 |
828282FF |
|
gray52 |
858585FF |
|
gray53 |
878787FF |
|
gray54 |
8A8A8AFF |
|
gray55 |
8C8C8CFF |
|
gray56 |
8F8F8FFF |
|
gray57 |
919191FF |
|
gray58 |
949494FF |
|
gray59 |
969696FF |
|
gray60 |
999999FF |
|
gray61 |
9C9C9CFF |
|
gray62 |
9E9E9EFF |
|
gray63 |
A1A1A1FF |
|
gray64 |
A3A3A3FF |
|
gray65 |
A6A6A6FF |
|
gray66 |
A8A8A8FF |
|
gray67 |
ABABABFF |
|
gray68 |
ADADADFF |
|
gray69 |
B0B0B0FF |
|
gray70 |
B3B3B3FF |
|
gray71 |
B5B5B5FF |
|
gray72 |
B8B8B8FF |
|
gray73 |
BABABAFF |
|
gray74 |
BDBDBDFF |
|
gray75 |
BFBFBFFF |
|
gray76 |
C2C2C2FF |
|
gray77 |
C4C4C4FF |
|
gray78 |
C7C7C7FF |
|
gray79 |
C9C9C9FF |
|
gray80 |
CCCCCCFF |
|
gray81 |
CFCFCFFF |
|
gray82 |
D1D1D1FF |
|
gray83 |
D4D4D4FF |
|
gray84 |
D6D6D6FF |
|
gray85 |
D9D9D9FF |
|
gray86 |
DBDBDBFF |
|
gray87 |
DEDEDEFF |
|
gray88 |
E0E0E0FF |
|
gray89 |
E3E3E3FF |
|
gray90 |
E5E5E5FF |
|
gray91 |
E8E8E8FF |
|
gray92 |
EBEBEBFF |
|
gray93 |
EDEDEDFF |
|
gray94 |
F0F0F0FF |
|
gray95 |
F2F2F2FF |
|
gray96 |
F5F5F5FF |
|
gray97 |
F7F7F7FF |
|
gray98 |
FAFAFAFF |
|
gray99 |
FCFCFCFF |
|
gray100 |
FFFFFFFF |
|
gray |
7E7E7EFF |
|
green |
008000FF |
|
greenyellow |
ADFF2FFF |
|
grey |
808080FF |
|
honeydew |
F0FFF0FF |
|
hotpink |
FF69B4FF |
|
indianred |
CD5C5CFF |
|
indigo |
4B0082FF |
|
ivory |
FFFFF0FF |
|
khaki |
F0E68CFF |
|
lavender |
E6E6FAFF |
|
lavenderblush |
FFF0F5FF |
|
lawngreen |
7CFC00FF |
|
lemonchiffon |
FFFACDFF |
|
lightblue |
ADD8E6FF |
|
lightcoral |
F08080FF |
|
lightcyan |
E0FFFFFF |
|
lightgoldenrodyellow |
FAFAD2FF |
|
lightgray |
D3D3D3FF |
|
lightgreen |
90EE90FF |
|
lightgrey |
D3D3D3FF |
|
lightpink |
FFB6C1FF |
|
lightsalmon |
FFA07AFF |
|
lightseagreen |
20B2AAFF |
|
lightskyblue |
87CEFAFF |
|
lightslategray |
778899FF |
|
lightslategrey |
778899FF |
|
lightsteelblue |
B0C4DEFF |
|
lightyellow |
FFFFE0FF |
|
lime |
00FF00FF |
|
limegreen |
32CD32FF |
|
linen |
FAF0E6FF |
|
magenta |
FF00FFFF |
|
maroon |
800000FF |
|
mediumaquamarine |
66CDAAFF |
|
mediumblue |
0000CDFF |
|
mediumorchid |
BA55D3FF |
|
mediumpurple |
9370DBFF |
|
mediumseagreen |
3CB371FF |
|
mediumslateblue |
7B68EEFF |
|
mediumspringgreen |
00FA9AFF |
|
mediumturquoise |
48D1CCFF |
|
mediumvioletred |
C71585FF |
|
midnightblue |
191970FF |
|
mintcream |
F5FFFAFF |
|
mistyrose |
FFE4E1FF |
|
moccasin |
FFE4B5FF |
|
navajowhite |
FFDEADFF |
|
navy |
000080FF |
|
none |
000000FF |
|
oldlace |
FDF5E6FF |
|
olive |
808000FF |
|
olivedrab |
6B8E23FF |
|
orange |
FFA500FF |
|
orangered |
FF4500FF |
|
orchid |
DA70D6FF |
|
palegoldenrod |
EEE8AAFF |
|
palegreen |
98FB98FF |
|
paleturquoise |
AFEEEEFF |
|
palevioletred |
DB7093FF |
|
papayawhip |
FFEFD5FF |
|
peachpuff |
FFDAB9FF |
|
peru |
CD853FFF |
|
pink |
FFC0CBFF |
|
plum |
DDA0DDFF |
|
powderblue |
B0E0E6FF |
|
purple |
800080FF |
|
red |
FF0000FF |
|
rosybrown |
BC8F8FFF |
|
royalblue |
4169E1FF |
|
saddlebrown |
8B4513FF |
|
salmon |
FA8072FF |
|
sandybrown |
F4A460FF |
|
seagreen |
2E8B57FF |
|
seashell |
FFF5EEFF |
|
sienna |
A0522DFF |
|
silver |
C0C0C0FF |
|
skyblue |
87CEEBFF |
|
slateblue |
6A5ACDFF |
|
slategray |
708090FF |
|
slategrey |
708090FF |
|
snow |
FFFAFAFF |
|
springgreen |
00FF7FFF |
|
steelblue |
4682B4FF |
|
tan |
D2B48CFF |
|
teal |
008080FF |
|
thistle |
D8BFD8FF |
|
tomato |
FF6347FF |
|
turquoise |
40E0D0FF |
|
violet |
EE82EEFF |
|
wheat |
F5DEB3FF |
|
white |
FFFFFFFF |
|
whitesmoke |
F5F5F5FF |
|
yellow |
FFFF00FF |
|
yellowgreen |
9ACD32FF |