Programmable Media

Upload Widget API reference

Last updated: May-05-2024

The Upload widget API reference details all the parameter options that you can use when configuring the Upload widget.

Initialization methods

The Initialization JavaScript methods are publicly available after including Cloudinary's Upload widget JavaScript file.

The all.js file instantiates the cloudinary class with access to the following methods:

Note

For the list of methods that can be used with the returned widget object from one of these initialization methods, see the instance methods.

setCloudName

Globally sets the cloud name for all widget method calls.

Syntax

cloudinary.setCloudName(name)

Parameter	Type	Description
name	String	The Cloudinary cloud name.

createUploadWidget

Creates a widget object and frame in memory, but does not display it until the open() method of the returned widget object is called.

Tip

Improve the perceived performance of your site by creating the widget while your site is loading and then calling the open() method from a click event.

Syntax

cloudinary.createUploadWidget(options, resultCallback)

Parameter	Type	Description
options	Map	A map of the Upload widget parameters to apply. See the parameters section for a full list of options available.
resultCallback	Function	An optional function called for event handling. The callback method has the following signature `function(error, result)` where `error` is either `null` if successful or an error message if there was a failure, while `result` is a JSON object detailing the triggered event.

openUploadWidget

Creates a widget object and frame in memory, and also opens the widget.

Syntax

cloudinary.openUploadWidget(options, resultCallback)

Parameter	Type	Description
options	Map	A map of the Upload widget parameters to apply. See the parameters section for a full list of options available.
resultCallback	Function	An optional function called for event handling. The callback method has the following signature `function(error, result)` where `error` is either `null` if successful or an error message if there was a failure, while `result` is a JSON object detailing the triggered event.

Creates a widget object and frame in memory, and also modifies a given element to a blue button (customizable look & feel) that, when clicked, opens a pre-created Upload widget. In addition, the form and thumbnails options are implicitly set by default to the containing form of the given element.

Syntax

cloudinary.applyUploadWidget(element, options, resultCallback)

Parameter	Type	Description
element	Element	The containing element on the page to be modified to a button.
options	Map	A map of the Upload widget parameters to apply. See the parameters section for a full list of options available.
resultCallback	Function	An optional function called for event handling. The callback method has the following signature `function(error, result)` where `error` is either `null` if successful or an error message if there was a failure, while `result` is a JSON object detailing the triggered event.

Example

cloudinary_upload_widget

Note

For use with jQuery - supported only for backward compatibility with Upload widget 1.x

Same as applyUploadWidget. Uses a jQuery selector to apply the widget on matching elements.

Example

Parameters

Important

Besides for the required parameters, only include other parameters in order to override their default values.

The following tables list all available parameters (options) for creating and initializing an Upload widget with one of the Initialization methods method:

Required parameters
Widget parameters
Cropping parameters
Sources parameters
Upload parameters
Client-side parameters
Containing page parameters
Customization parameters
Advanced parameters

Note

The standard camelCase option names are shown here.
For backward compatibility with Upload widget 1.x, snake_case is also supported.

Required parameters

The following parameters are required when initializing the Upload widget:

Parameter	Type	Description
cloudName	String	Your Cloudinary product environment cloud name. Can be set either globally using `setCloudName` or explicitly for each widget creation call. Example: `demo`
uploadPreset	String (optional if `uploadSignature` is used)	The name of an upload preset defined for your product environment. If using the Upload widget for unsigned uploads, make sure you specify an unsigned upload preset, and conversely, if you choose to provide an upload preset for a widget performing signed uploads, make sure you provide a signed upload preset. You can define upload presets either on the Upload page of the Console Settings or by using the Admin API. Example: `preset1`

Widget parameters

Parameter	Type	Description
sources	Array of Strings	List of sources that should be added as tabs (web) or source options (mobile/responsive) in the widget. Possible values: `local`, `url`, `camera`, `dropbox`, `image_search`, `shutterstock`, `gettyimages`, `istock`, `unsplash`, `google_drive` Notes: The sources are displayed in the same order that you add them to this parameter. `camera` is not relevant for mobile devices (the `local` option also allows capturing from the camera on mobile devices) and is currently supported in all modern browsers (not supported in Internet Explorer or Desktop Safari). The `camera` and `dropbox` source options will appear only if the Upload widget is embedded in an HTTPS page.
secure	Boolean	Whether the widget uses the HTTPS protocol instead of HTTP. Default: `true`.
encryption	Map of key-iv pairs	The encryption key and initialization vector to use for encrypting uploaded files. Example:`{ key: "ff234fe526725753fa45b53325", iv: "cd8a46d72e26a365dca78ef" }`
defaultSource	String	The source that's selected when the widget is opened. Default: `local`
multiple	Boolean	Whether selecting and uploading multiple assets is allowed. Completion callback is called only when all assets complete uploading. If set to true, multiple hidden fields of asset identifiers are created. If set to false, only a single asset is allowed in any source. See note below. Default: `true`
maxFiles	Integer	The maximum number of files allowed in multiple upload mode. If a user selects or drags more than the allowed amount, no files will be uploaded. See note below. Default: unlimited Example: `10`

Note

Cloudinary recommends setting a limit for maxFiles. Although the widget does not limit the number of uploads from the front end side, there is a limit of 20 simultaneous calls on the backend side.

Cropping parameters

Parameter	Type	Description
cropping	Boolean	Set to `true` if you want to allow your users to interactively crop their images before uploading them to Cloudinary. Interactive cropping allows users to mark the interesting part of images, and the selected dimensions are sent as the `customCoordinates` or `faceCoordinates` upload parameter, depending on the value used for `croppingCoordinatesMode`. Setting `gravity` to `custom` or `faces` (as appropriate) when generating delivery URLs will deliver the image with the cropping that the user defined in the widget. Incoming cropping can be applied before saving the image by including the crop mode set to `custom` gravity in your upload preset. Cropping is supported only with single-file uploading so make sure to also set the `multiple` widget parameter to `false` in order to enable interactive cropping. Note: This step is skipped if the user uploads a video or an image format that is not supported by browsers (e.g., PSD or SVG files). Default: `false`
showSkipCropButton	Boolean	Whether to display the 'skip' button on the interactive cropping step, making the step mandatory if set to false. Relevant only if the `cropping` feature is enabled. Note: In some cases, the button will still be shown regardless of this setting (e.g. if croppingAspectRatio is set to 1.0 and the user tries to upload an image already with an aspect ratio of 1.0) Default: `true`
croppingAspectRatio	Decimal	If specified, enforce the given aspect ratio on the selected region when performing interactive cropping. The aspect ratio is defined as width/height. For example, 0.5 for a portrait oriented rectangle or 1 for square. Relevant only if the `cropping` feature is enabled. Note: If the user tries to upload an asset with the exact same aspect ratio, the 'crop' button will start off disabled. The user will either have to click the 'skip' button, or slightly modify the cropping region to enable the 'crop' button. Default: `null` Example: `0.5`
croppingDefaultSelectionRatio	Decimal	Initialize the size of the cropping selection box to a different value from the default. The value is calculated as a proportion of the image's size. Relevant only if the `cropping` feature is enabled. Default: `1.0`. Range: `0.1` to `1.0`. Example: `0.75`
croppingShowDimensions	Boolean	Whether to display the cropping dimensions in the top left corner of the cropping region. Relevant only if the `cropping` feature is enabled. Default: `false`.
croppingCoordinatesMode	String: `custom` or `face`	Determines how to apply the selected region coordinates: `custom` - the selected region is set as the `customCoordinates` upload parameter (default). `face` - the selected region is set as the `faceCoordinates` upload parameter. Relevant only if the `cropping` feature is enabled.
croppingShowBackButton	Boolean	Whether to show a Back button when in cropping mode. Relevant only if the `cropping` feature is enabled. Default: `true`

Sources parameters

See the Third-party upload sources section for more details on working with the various sources.

Parameter	Type	Description
`Dropbox:`
dropboxAppKey	String	Your DropBox App key. Required if adding the `dropbox` source.
`Image search:`
googleApiKey	String	Your API key needed to access Google APIs. Required if adding the `image_search` source.
searchBySites	Array of strings	The URLs of sites to allow for Image Search. If more than one site is given, the Search by Site drop-down is added. To allow searching the entire web, use the value "all". Default: `all`
searchByRights	Boolean	Set to `true` to add a drop-down box for your users to select a licensing filter when using the search. Default: `false`
`Google Drive:`
googleDriveClientId	String	The Client ID of your own Google Drive application for accessing your users Google Drive accounts. Defaults to using the Cloudinary Google Drive app to access their accounts if not provided.

Upload parameters

Parameter	Type	Description
publicId	String	Custom public ID to assign to a single uploaded asset. If not specified, either a randomly generated string or the original file name is used as the public ID according to the unsigned upload preset. To ensure secure usage, overwriting previously uploaded assets sharing the same public ID is not supported (unless you also include "overwrite = true" in the upload preset). Default: `null`. Example: `profile_11002`
folder	String	Folder name for all uploaded assets. Default: `null` (uploads to the root folder). Example: `user_photos`
useAssetFolderAsPublicIdPrefix	Boolean	Whether to use the given folder as a prefix for all public IDs. Default: `false`
publicIdPrefix	String	The string to add as a prefix for all public IDs.
tags	Array of Strings	One or more tags to assign to the uploaded assets. Default: `null`. Example: `['users', 'content']`
resourceType	String	Limits uploaded files to the specified type. By default, all resource types are allowed. Possible values: `auto`, `image`, `video`, `raw`. Default: `auto`.
context	Map of key-value pairs	Additional contextual metadata to attach to the uploaded resources. Example:`{ alt: "my_alt", caption: "my_caption"}`
detection	String	Invokes the relevant add-on. Set to: <content-aware model>_[<version>] (e.g. `coco_v2`) to detect content using the Cloudinary AI Content Analysis add-on. `adv_face` to detect facial attributes using the Advanced Facial Attribute Detection add-on. `aws_rek_face` to detect celebrities and facial attributes using the Amazon Rekognition Celebrity Detection add-on.
onSuccess	String	Allows you to update an asset by specifying custom logic with JavaScript that is executed after the upload to Cloudinary is completed successfully. This can be useful for conditionally adding tags, contextual metadata, and structured metadata, depending on the results of using the `detection` parameter on upload. For more details see On Success update script.
uploadSignature	string or function	Either a string representing the precalculated signature of all upload parameters used, or a function to generate the signature string dynamically. The function accepts 2 parameters, the first is a resultCallback (function) and the second is an object with the relevant upload parameters that are needed for generating the signature. Example: `c347053314777423cd4f` For details, see Generating authentication signatures.
uploadSignatureTimestamp	Number	The Unix time in seconds of the current time. The timestamp is valid for 1 hour. Relevant only if `uploadSignature` is also provided. Example: `1315060076`

Client-side parameters

Parameter	Type	Description
clientAllowedFormats	Array of Strings	Allows client-side validation of the uploaded files based on their file extensions. You can specify one or more file extensions, and/or limit the allowed files to "video" or "image". Only applies when uploading files from a local device. Note: As a shortcut, you can use a string to pass a single value (e.g. "gif") Default: `null`. Example: `["webp", "gif", "video"]`
maxFileSize	Integer. Number of bytes.	If specified, perform client-side validation to prevent uploading files larger than the given bytes size. Default: null (no client-side limit) Example: `5500000` (5.5 MB) Notes: - Applies to `local` files only - Upload size is limited on the server side by the maximum file size set in your account's Usage Limits - The preview, crop, and pixel-count options are not available for files larger than 40 MB (the files can still be uploaded)
maxImageFileSize	Integer. Number of bytes.	If specified, perform client-side validation to prevent uploading image files larger than the given bytes size. Default: null (no client-side limit) Example: `1500000` (1.5 MB) Notes: - Overrides `maxFileSize` (if set) for images - Applies to `local` files only - Upload size is limited on the server side by the maximum file size set in your account's Usage Limits - The preview, crop, and pixel-count options are not available for files larger than 40 MB (the files can still be uploaded)
maxVideoFileSize	Integer. Number of bytes.	If specified, perform client-side validation to prevent uploading video files larger than the given bytes size. Default: null (no client-side limit) Example: `15000000` (15 MB) Notes: - Overrides `maxFileSize` (if set) for videos - Applies to `local` files only - Upload size is limited on the server side by the maximum file size set in your account's Usage Limits
maxRawFileSize	Integer. Number of bytes.	If specified, perform client-side validation to prevent uploading raw files larger than the given bytes size. Default: null (no client-side limit) Example: `2000000` (2 MB) Notes: - Overrides `maxFileSize` (if set) for raw files - Applies to `local` files only - Upload size is limited on the server side by the maximum file size set in your account's Usage Limits
maxImageWidth	Integer. Number of pixels.	If specified, client-side scale-down resizing takes place before uploading if the width of the selected file is larger than the specified value. Alternatively, can be used in conjunction with `validateMaxWidthHeight` to prevent uploading of images that exceed this value. Note: Only relevant when uploading local files, and not files from a URL. Default: `null` (no resizing) Example: `2000`
maxImageHeight	Integer. Number of pixels.	If specified, client-side scale-down resizing takes place before uploading if the height of the selected file is larger than the specified value. Alternatively, can be used in conjunction with `validateMaxWidthHeight` to prevent uploading of images that exceed this value. Note: Only relevant when uploading local files, and not files from a URL. Default: `null` (no resizing) Example: `2000`
validateMaxWidthHeight	Boolean	If specified, client-side validation takes place before uploading. If the width and/or height of the image is larger than `maxImageWidth` and/or `maxImageHeight` respectively, the upload is cancelled and no client-side scale-down resizing takes place. Default: `false` (no validation)
minImageWidth	Integer. Number of pixels.	If specified, client-side validation takes place before uploading. If the width of the selected file is smaller than the specified value, the upload is cancelled. Note: Only relevant when uploading local files, and not files from a URL. Default: `null` (no validation) Example: `200`
minImageHeight	Integer. Number of pixels.	If specified, client-side validation takes place before uploading. If the height of the selected file is smaller than the specified value, the upload is cancelled. Note: Only relevant when uploading local files, and not files from a URL. Default: `null` (no validation) Example: `200`
croppingValidateDimensions	Boolean	Relevant only if the `cropping` feature is enabled AND one or more of the following parameters are also set: `maxImageWidth`, `maxImageHeight`, `minImageWidth` or `minImageHeight`. If specified, the client-side validation takes place both on the size of the original image and on the size of the `cropping` region marked by the user. Default: `false`.
maxChunkSize	Integer. Number of bytes.	Configure the maximum chunk size for uploading large files. The value must be at least 5 MB (`5000000`). Default: `20000000`

Containing page parameters

Parameter	Type	Description
form	CSS selector	The selector (CSS path) of the form, to which you would like to append hidden fields with the identifiers of the uploaded assets. Implicitly set by default to the containing form of the given element when the widget is created using `applyUploadWidget` or `$.fn.cloudinary_upload_widget`. Default: `null` Example: `#my_form`
fieldName	Form field name	The name of the hidden field added to your form when uploading is completed. Multiple hidden fields with the same name are created for multiple uploaded assets. The name can include `[]` for supporting web frameworks such as Ruby on Rails. Default: `image` Example: `photo[]`
thumbnails	CSS selector	The selector (CSS path) of an HTML element that acts as the container for appending upload thumbnails. Implicitly appended by default to the containing element (if it exists) of the Upload widget element. If you don't want to display thumbnails at all, set to 'false'. Default: `null` Example: `.content .uploaded`
thumbnailTransformation	String or Array of maps	The Cloudinary transformation (manipulation) to apply on uploaded assets for embedding thumbnails in your site. Any resizing, cropping, effects, and other Cloudinary image transformation options can be applied by specifying a transformation string or an array of mapped transformations. Thumbnail transformations can be eagerly generated during upload by defining a set of eager transformations in your defined upload preset. Default: `[{ width: 90, height: 60, crop: 'limit' }]` Examples: `[{ width: 100, height: 100, crop: 'fit' }]` `[ {width: 200, height: 200, crop: 'fill'}, {effect: 'sepia'} ]` `"w_200,h_200,c_fill"`

Customization parameters

Parameter	Type	Description
buttonClass	String	Enables you to override the default CSS class name of the upload button added to your site. The default CSS style is applied to the `cloudinary-button` class, which you can override using CSS directives. Alternatively, you can specify any class name that matches your website design. Default: `cloudinary-button`
buttonCaption	String	Enables you to override the default caption of the upload button added to your site. Default: `Upload image`
theme	String	The name of a predefined widget theme. Widget behavior is the same for all themes. Supported themes: `default`, `white`, `minimal`, `purple`. Default: `default`
styles	Object	Advanced customization of the widget's look & feel. Enables you to override the widget's default colors, fonts, icons and other elements by providing a custom style definition. See the Look and feel customization sample as a reference implementation. Default: the widget's default settings are used for all elements that are not specifically overridden
text	Object	"key":"value" pairs of text to override the widget's default text labels. See the Localization sample as a reference implementation.

Advanced parameters

Parameter	Type	Description
showPoweredBy	Boolean	Whether the Powered By Cloudinary icon is displayed. Default: `true`. Note: Supported only for paid Cloudinary accounts and requires some time for cache expiration.
autoMinimize	Boolean	Automatically minimize the widget after the upload begins. Default: `false`
getTags	Function	A function that is called for adding tagging suggestions whenever the text changes in the `Add a Tag` Advanced text field.
getUploadPresets	Function	A function that is called for populating an upload preset selection field added to the Advanced options.
preBatch	Function	A function that performs pre-batch validation before the upload starts.
prepareUploadParams	Function	A function for preparing upload parameters before the upload starts. The prepareUploadParams callback only supports preparing the following parameters: `apiKey`, `auditContext`, `context`, `folder`, `invalidate`, `metadata`, `overwrite`, `publicId`, `qualityAnalysis`, `resourceType`, `signature`, `tags`, `uniqueFilename`, `uploadPreset` `uploadSignatureTimestamp`, `useFilename`.
language	String	Determines which of the `text` parameter languages to use for the widget. Default: `en`
showAdvancedOptions	Boolean	Whether to display the Advanced options, which enables users to set the Public ID, Add a Tag, and select an Upload Preset (only if `getUploadPresets` is defined). Default `false`
showCompletedButton	Boolean	Whether the Completed button will be displayed after the upload completes. When a user clicks the button, the widget fires the `show-completed` event. Default `false`
showUploadMoreButton	Boolean	Whether the Upload More button will be displayed after the upload completes. Default: `true`
singleUploadAutoClose	Boolean	Whether the Upload widget automatically closes after the upload completes. Default: `true`
queueViewPosition	String	The display position of the minimized upload queue expressed as an offset value from either the right or left edge, followed by a colon and then the offset value in CSS units from that edge. Default `right:35px`
showInsecurePreview	Boolean	Whether the widget displays a preview of assets from HTTP (non-secure) URLs selected for uploading. Assets from HTTPS URLs will display a preview regardless of this parameter's value. Default `false`
inlineContainer	String selector or DOM element	Enables embedding the widget inside your web page instead of it appearing as a modal dialog. Default: `null` Examples: `#my-widget-container` `document.getElementById('my-widget-container');`

Instance methods

The following methods can be used with the widget object that is returned by one of the Initialization methods:

open

Renders an existing widget currently in memory, but that is not currently displayed.

Syntax

open(source, options)

Parameter	Type	Description
source	String	The source (tab) the widget should open on. Default: null
options	Map	Any optional values to pass. Currently supports: - `files`: (Array of strings) Optional asset URLs, in which case the widget either skips directly to uploading the given assets, or skips the source selection options and opens the widget with the given assets ready for cropping (if that option is enabled).

Example

close

Closes and resets the widget to its initial state without removing it from memory.

See also: destroy | hide

Syntax

close(options)

Parameter	Type	Description
options	Map	Any optional values to pass. Currently supports: - `quiet`: (boolean) When true, skips the confirmation box if the widget is closed while still uploading assets. Default: false.

Example

update

Updates a widget currently in memory with new options.

Syntax

update(options)

Parameter	Type	Description
options	Map	A map of the Upload widget parameters to apply. See the parameters section for a full list of options available.

Note

The following parameters are NOT supported by update: secure, uploadSignature, getTags, preBatch, inlineContainer, and fieldName.

Parameter	Type	Description
options	Map	Any optional values to pass. Currently supports: - `removeThumbnails` (Boolean) When true, also removes any thumbnails that were displayed after upload. Default: false.

The following list details every event fired as well as the corresponding information passed to the result object:

✖️

Error

Unfortunately there's been an error sending your feedback.

Rate this page: