Skip to main content
Server path: /cloudinary-assets | Type: Application | PCID required: Yes

​
Tools

ToolDescription
cloudinary_assets_create_asset_relations_by_asset_idAdd related assets by asset ID
cloudinary_assets_create_asset_relations_by_public_idCreate asset relations by public ID
cloudinary_assets_delete_asset_relations_by_asset_idDelete asset relations by asset ID
cloudinary_assets_delete_asset_relations_by_public_idDelete asset relations by public ID
cloudinary_assets_delete_backup_versionsDelete backed up versions
cloudinary_assets_delete_resources_by_public_idDelete resources by public ID
cloudinary_assets_derived_destroyDelete derived resources
cloudinary_assets_destroy_assetDestroys an asset/resource
cloudinary_assets_destroy_by_asset_idDelete asset by asset-id
cloudinary_assets_download_assetGenerates a download link for a specific asset (image)
cloudinary_assets_download_backup_assetDownload a backup copy of an asset
cloudinary_assets_explicit_assetApply operations on an existing asset
cloudinary_assets_explode_resourceCreate derived images from multi-page file
cloudinary_assets_generate_archiveCreates an archive (ZIP or TGZ file) that contains a set of assets from your product environment.
cloudinary_assets_get_resource_by_asset_idGet resource by asset ID
cloudinary_assets_get_resource_by_public_idGet resource by public ID
cloudinary_assets_get_video_viewsGet video views
cloudinary_assets_list_imagesGet image assets
cloudinary_assets_list_raw_filesGet raw assets
cloudinary_assets_list_resource_tagsRetrieves a list of tags currently applied to assets in your Cloudinary account
cloudinary_assets_list_resource_typesGet resource types
cloudinary_assets_list_resources_by_asset_folderGet resources by asset folder
cloudinary_assets_list_resources_by_asset_idsGet resources by asset IDs
cloudinary_assets_list_resources_by_contextGet resources by context
cloudinary_assets_list_resources_by_external_idsGet resources by external IDs
cloudinary_assets_list_resources_by_moderation_kind_and_statusGet resources by moderation kind and status
cloudinary_assets_list_videosGet video assets
cloudinary_assets_rename_assetUpdates an existing asset’s identifier (public ID) and optionally other metadata in your Cloudinary account
cloudinary_assets_restore_resources_by_asset_idsRestore assets by asset ID
cloudinary_assets_textCreate image from text
cloudinary_assets_update_resource_by_asset_idUpdates an existing asset’s metadata, tags, and other attributes using its asset ID
cloudinary_assets_update_resource_by_public_idUpdate asset by public ID
cloudinary_assets_uploadUploads media assets (images, videos, raw files) to your Cloudinary product environment
cloudinary_assets_upload_chunkUpload a single chunk of a large file
cloudinary_assets_upload_no_resource_typeUpload with automatic file type detection

​
cloudinary_assets_create_asset_relations_by_asset_id

Add related assets by asset ID Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
assets_to_relatestring[]Yes—Relates the asset to all the assets specified in this array of up to 10 assets, specified by their asset IDs.

​
cloudinary_assets_create_asset_relations_by_public_id

Create asset relations by public ID Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
typestringYes—The delivery type of the asset.
public_idstringYes—The public ID of the asset.
assets_to_relatestring[]Yes—Relates the asset to all the other assets specified in this array of up to 10 assets, specified as resource_type/type/public_id.

​
cloudinary_assets_delete_asset_relations_by_asset_id

Delete asset relations by asset ID Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
assets_to_unrelatestring[]Yes—Unrelates the asset from all the assets specified in this array of assets, specified by their asset IDs.

​
cloudinary_assets_delete_asset_relations_by_public_id

Delete asset relations by public ID Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
typestringYes—The delivery type of the asset.
public_idstringYes—The public ID of the asset.
assets_to_unrelatestring[]Yes—Unrelates the asset from all the assets specified in this array of assets, specified as resource_type/type/public_id.

​
cloudinary_assets_delete_backup_versions

Delete backed up versions Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
version_idsstring[]Yes—The list of version IDs to delete from backup.

​
cloudinary_assets_delete_resources_by_public_id

Delete resources by public ID Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
typestringYes—The extended storage type of the resource.
allbooleanNo—Delete all assets (of the relevant resource_type and type), including derived assets (up to a maximum of 1000 original resources).
invalidatebooleanNo—Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. Default: false.
keep_originalbooleanNo—Whether to delete only the derived assets. Default: false.
next_cursorstringNo—(Only when deleting by prefix or all) When a deletion request has more than 1000 resources to delete, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request.
prefixstringNo—Delete all assets, including derived assets, where the public ID starts with the specified prefix (up to a maximum of 1000 original resources).
public_idsstring[]No—A list of public IDs of the resources to delete.
transformationsstringNo—Only the derived assets matching this hash of transformation parameters will be deleted. You can include multiple transformations separated by a pipe character (|).

​
cloudinary_assets_derived_destroy

Delete derived resources Parameters:
ParameterTypeRequiredDefaultDescription
derived_resource_idsstring[]Yes—Array of derived resource IDs to delete specific derived resources
invalidatebooleanNo—Whether to invalidate the CDN cache for the deleted resources

​
cloudinary_assets_destroy_asset

Destroys an asset/resource Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
invalidatebooleanNo—Whether to invalidate CDN cached copies of the asset.
public_idstringYes—The public ID of the asset.

​
cloudinary_assets_destroy_by_asset_id

Delete asset by asset-id Parameters:
ParameterTypeRequiredDefaultDescription
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asset_idstringYes—The ID of the asset to delete.
callbackstringNo—URL for redirect after operation completion.
invalidatebooleanNo—Whether to invalidate CDN cache. Default is false.
notification_urlstringNo—URL to receive completion notification.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.

​
cloudinary_assets_download_asset

Generates a download link for a specific asset (image) Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
public_idstringYes—The public ID of the asset.
formatstringNo—The format to convert the asset to before downloading.
typestringNo—The storage type of the asset. Default is “upload”.
expires_atintegerNo—Unix timestamp indicating when the download URL should expire.
attachmentbooleanNo—Whether to force download as an attachment.
target_filenamestringNo—The desired filename for the downloaded file.
transformationstringNo—A transformation to apply to the asset before downloading.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.

​
cloudinary_assets_download_backup_asset

Download a backup copy of an asset Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
version_idstringYes—The version ID of the backup to download. Must be a 32-character hexadecimal string.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.

​
cloudinary_assets_explicit_asset

Apply operations on an existing asset Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
accessibility_analysisbooleanNo—Whether to return return accessibility analysis values for the image.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asset_folderstringNo—The asset folder to assign to the asset.
asyncbooleanNo—When set to true, returns the uploaded asset’s public_id immediately in the response, before the upload is completed (asynchronously). Default: false.
auto_chapteringbooleanNo—Whether to trigger automatic generation of video chapters. Chapters will be generated and saved as a .vtt file with -chapters appended to the public ID of the video. You can enable chapters as part of the Cloudinary Video Player. Relevant for videos only.
auto_transcriptionobjectNo—Auto Transcription
callbackstringNo—A URL to redirect to after the upload/explicit is completed instead of returning the upload response. Signed upload result parameters are added to the callback URL. This parameter is ignored for XHR (Ajax XMLHttpRequest) or JavaScript Fetch API upload requests. Note: This parameter is relevant for direct uploads from a form in the browser. It is automatically set if you perform direct upload from the browser using Cloudinary’s SDKs and the jQuery plugin.
cinemagraph_analysisbooleanNo—Whether to return a cinemagraph analysis value for the media asset between 0 and 1, where 0 means the asset is not a cinemagraph and 1 means the asset is a cinemagraph. Relevant for animated images and video only. A static image will return 0.
colorsbooleanNo—Whether to retrieve predominant colors & color histogram of the uploaded image. Note: If all returned colors are opaque, then 6-digit RGB hex values are returned. If one or more colors contain an alpha channel, then 8-digit RGBA hex quadruplet values are returned.
contextstringNo—Key-value pairs of general textual context metadata to attach to the asset.
custom_coordinatesstringNo—An array of coordinates for custom cropping.
display_namestringNo—A display name for the asset.
eagerstringNo—A list of transformations to eagerly generate for the asset. Accepts either a single transformation or a pipe-separated list of transformations.
eager_asyncbooleanNo—Whether to generate the eager transformations asynchronously in the background after the upload request is completed rather than before the upload is completed.
eager_notification_urlstringNo—A URL to notify when eager transformations are completed.
face_coordinatesstringNo—An array of coordinates representing detected faces in the asset, used for custom cropping or overlays.
facesbooleanNo—Whether to detect faces in the asset.
headersstringNo—An HTTP header or a list of headers lines for adding as response HTTP headers when delivering the asset to your users. Supported headers: Link, Authorization, X-Robots-Tag.
invalidatebooleanNo—Whether to invalidate CDN cache copies of a previously uploaded asset that shares the same public ID. Default: false.
media_metadatabooleanNo—Whether to return IPTC, XMP, and detailed Exif metadata of the uploaded asset in the response. Supported for images, video, and audio. - Returned metadata for images includes: PixelsPerUnitX, PixelsPerUnitY, PixelUnits, Colorspace, and DPI. - Returned metadata for audio and video includes: audio_codec, audio_bit_rate, audio_frequency, channels, channel_layout. - Additional metadata for video includes: pix_format, codec, level, profile, video_bit_rate, dar.
metadatastringNo—Structured metadata to attach to the asset based on the metadata fields defined for your account.
moderationstringNo—For all asset types, set to: - manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console. - perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on. For images only, set to: - webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on. - aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on. - duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image. For videos only, set to: - aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on. - google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on. To request multiple moderations in a single API call: - Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last. Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.
notification_urlstringNo—A URL to notify when the asset is ready.
overwritebooleanNo—When applying eager for already existing video transformations, this setting indicates whether to force the existing derived video resources to be regenerated. Default for videos: false. Note: When specifying existing eager transformations for images, corresponding derived images are always regenerated.
phashbooleanNo—Whether to return the perceptual hash (pHash) on the uploaded image for image similarity detection.
public_idstringYes—The public ID of the existing asset to apply operations on.
quality_analysisbooleanNo—Whether to return a quality analysis value for the image between 0 and 1, where 0 means the image is blurry and out of focus and 1 means the image is sharp and in focus. Relevant for images only.
quality_overrideobjectNo—Override the quality setting for this asset.
regionsstringNo—Regions to detect in the asset.
responsive_breakpointsobject[]No—Settings to automatically generate breakpoints for responsive images.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
tagsstringNo—A comma-separated list of tag names to assign to the asset.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
typestringNo—The storage type of resources to include in the archive.

​
cloudinary_assets_explode_resource

Create derived images from multi-page file Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource to explode. Only “image” is supported.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
formatstringNo—The format for the generated derived images. Default: png
notification_urlstringNo—The webhook URL to notify when the operation is complete.
public_idstringYes—The public ID of the PDF or animated image to generate from.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
transformationstringYes—The transformation to apply. Must contain exactly one pg_all transformation parameter.
typestringNo—The storage type of the resource.

​
cloudinary_assets_generate_archive

Creates an archive (ZIP or TGZ file) that contains a set of assets from your product environment. Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resources to include in the archive. “image” for images, “video” for videos, “raw” for non-media files, or “all” for mixed types.
allow_missingbooleanNo—Whether to allow missing assets in the archive. If false, the operation will fail if any asset is not found.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asyncbooleanNo—(“create” mode only), specifies whether to generate the archive asynchronously.
expires_atintegerNo—(“download” mode only) Unix timestamp indicating when the generated archive URL should expire.
flatten_foldersbooleanNo—Whether to flatten all files to be in the root of the archive file.
flatten_transformationsbooleanNo—Whether to flatten the folder structure of the derived assets.
keep_derivedbooleanNo—Whether to keep the derived assets used for generating the archive.
modestringNo—The method for generating and delivering the archive. Options: download - Generates and delivers the archive file without storing it create - Creates and stores the archive as a raw asset, returning URLs in the response create_and_download - Creates, stores, and delivers the archive file
notification_urlstringNo—(“create” mode only), specifies the URL to notify when the archive generation is complete.
prefixesstring[]No—Select all assets where the public ID starts with this prefix. Up to 20 prefixes are supported.
public_idsstring[]No—The list of public IDs to include in the archive. Up to 1000 public IDs are supported.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
skip_transformation_namebooleanNo—Whether to skip adding the transformation details to the file names in the archive.
tagsstring[]No—A tag to use for selecting assets to include in the archive. Up to 20 tags are supported.
target_asset_folderstringNo—The folder in your product environment where the generated archive should be stored.
target_formatstringNo—The format of the generated archive.
target_public_idstringNo—The public ID to assign to the generated archive, or the filename of the downloaded archive file.
target_tagsstring[]No—A list of tag names to assign to the generated archive.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
transformationsstringNo—The transformations to apply to the assets before including them in the archive (separated by ”|”).
typestringNo—The storage type of resources to include in the archive.
use_original_filenamebooleanNo—Whether to use the original filenames of the assets in the archive instead of public IDs (when available).

​
cloudinary_assets_get_resource_by_asset_id

Get resource by asset ID Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
colorsbooleanNo—Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.
media_metadatabooleanNo—Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.
facesbooleanNo—Whether to include a list of coordinates of detected faces. Default: false.
quality_analysisbooleanNo—Whether to return quality analysis scores for the image. Default: false.
accessibility_analysisbooleanNo—Whether to return accessibility analysis scores for the image. Default: false.
pagesbooleanNo—Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.
phashbooleanNo—Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.
coordinatesbooleanNo—Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.
versionsbooleanNo—Whether to include details of all the backed up versions of the asset. Default: false.
max_resultsintegerNo—Maximum number of derived assets to return. Default: 10.
derived_next_cursorstringNo—The cursor for the next page of derived assets when there are more derived images than max_results.

​
cloudinary_assets_get_resource_by_public_id

Get resource by public ID Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
typestringYes—The extended storage type of the resource.
public_idstringYes—The public ID of the asset.
colorsbooleanNo—Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.
media_metadatabooleanNo—Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.
facesbooleanNo—Whether to include a list of coordinates of detected faces. Default: false.
quality_analysisbooleanNo—Whether to return quality analysis scores for the image. Default: false.
accessibility_analysisbooleanNo—Whether to return accessibility analysis scores for the image. Default: false.
pagesbooleanNo—Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.
phashbooleanNo—Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.
coordinatesbooleanNo—Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.
versionsbooleanNo—Whether to include details of all the backed up versions of the asset. Default: false.
max_resultsintegerNo—Maximum number of derived assets to return. Default: 10.
derived_next_cursorstringNo—The cursor for the next page of derived assets when there are more derived images than max_results.

​
cloudinary_assets_get_video_views

Get video views Parameters:
ParameterTypeRequiredDefaultDescription
expressionstringNo—A set of conditions used to limit the results to rows that match those conditions. For example: ?expression=video_public_id=skate
max_resultsintegerNo—The maximum number of results to return. Default is 10.
sort_bystringNo—Specifies the expression field by which to sort the results. Prepend values with a ’-’ to reverse the order.
next_cursorstringNo—The cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

​
cloudinary_assets_list_images

Get image assets Parameters:
ParameterTypeRequiredDefaultDescription
typestringNo—The storage type of the assets. Necessary for prefix filtering.
prefixstringNo—Find resources with a public ID prefix. Requires the type parameter.
public_idsstring[]No—An array of public IDs to return.
tagsbooleanNo—Whether to include the list of tag names assigned to each asset. Default: false
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.
start_atstringNo—Retrieve resources uploaded after this timestamp.
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_list_raw_files

Get raw assets Parameters:
ParameterTypeRequiredDefaultDescription
typestringNo—The storage type of the assets. Necessary for prefix filtering.
prefixstringNo—A public_id prefix. When specified, all assets with that prefix are returned. When using this, the type parameter must also be specified.
public_idsstring[]No—An array of public IDs to return.
tagsbooleanNo—Whether to include the list of tag names assigned to each asset. Default: false
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.
start_atstringNo—An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither prefix nor public_ids were passed.
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_list_resource_tags

Retrieves a list of tags currently applied to assets in your Cloudinary account Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
prefixstringNo—The prefix to use if you want to limit the returned tags to those that start with the specified prefix.
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).

​
cloudinary_assets_list_resource_types

Get resource types

​
cloudinary_assets_list_resources_by_asset_folder

Get resources by asset folder Parameters:
ParameterTypeRequiredDefaultDescription
asset_folderstringYes—The full path of the asset folder.
resource_typestringNo—Filter by resource type within the folder.
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_list_resources_by_asset_ids

Get resources by asset IDs Parameters:
ParameterTypeRequiredDefaultDescription
asset_idsstring[]Yes—List of asset IDs to retrieve (max 100).
resource_typestringNo—Resource type (optional, can sometimes disambiguate).
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_list_resources_by_context

Get resources by context Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
keystringYes—Context key to filter by.
valuestringNo—Context value to filter by.
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_list_resources_by_external_ids

Get resources by external IDs Parameters:
ParameterTypeRequiredDefaultDescription
external_idsstring[]Yes—List of external IDs for identifying the assets to retrieve. Either external_ids or asset_ids must be provided.
resource_typestringNo—Resource type (optional).
fieldsstring[]No—A comma-separated list of fields to include in the response. Notes: This parameter takes precedence over other parameters requesting details in the response (e.g., tags or context), so include them in this list if you also want their details returned. The following fields are always included in the response: public_id, and asset_id.
tagsbooleanNo—Whether to include the list of tag names assigned to each asset. Default: false.
contextbooleanNo—Whether to include key-value pairs of contextual metadata associated with each asset. Default: false.
metadatabooleanNo—Whether to include the structured metadata fields and values assigned to each asset. Default: false.
moderationsbooleanNo—Whether to include image moderation status of each asset. Default: false.

​
cloudinary_assets_list_resources_by_moderation_kind_and_status

Get resources by moderation kind and status Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
moderation_kindstringYes—Moderation Kind
moderation_statusstringYes—Moderation Status
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.

​
cloudinary_assets_list_videos

Get video assets Parameters:
ParameterTypeRequiredDefaultDescription
typestringNo—The storage type of the assets. Necessary for prefix filtering.
prefixstringNo—A public_id prefix. When specified, all assets with that prefix are returned. When using this, the type parameter must also be specified.
public_idsstring[]No—An array of public IDs to return.
tagsbooleanNo—Whether to include the list of tag names assigned to each asset. Default: false
next_cursorstringNo—Cursor for pagination.
max_resultsintegerNo—Maximum number of results to return (1-500).
directionstringNo—Sort direction.
start_atstringNo—An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither prefix nor public_ids were passed.
fieldsstring[]No—A comma-separated list of fields to include in the response. The following fields are always included in the response: public_id, and asset_id.

​
cloudinary_assets_rename_asset

Updates an existing asset’s identifier (public ID) and optionally other metadata in your Cloudinary account Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
contextstringNo—Context metadata to update during rename.
from_public_idstringYes—The public ID of the asset to rename.
invalidatebooleanNo—Whether to invalidate the CDN cache for the renamed asset.
metadatastringNo—Structured metadata to update during rename.
notification_urlstringNo—URL to notify when the operation is complete.
overwritebooleanNo—Whether to overwrite the target asset if it already exists.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
to_public_idstringYes—The new public ID for the asset.
to_typestringNo—The storage type of the resource.
typestringNo—The storage type of the resource.

​
cloudinary_assets_restore_resources_by_asset_ids

Restore assets by asset ID Parameters:
ParameterTypeRequiredDefaultDescription
asset_idsstring[]Yes—The unique and immutable asset IDs of backed up assets to restore.
notification_urlstringNo—The URL that will receive notification when restore is complete.
versionsstring[]No—If you specify versions, the number of versions in the array must exactly match the number of asset_ids.

​
cloudinary_assets_text

Create image from text Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource to create. Must be “image” for text generation.
backgroundstringNo—Name or RGB representation of the background color (e.g., red or
font_colorstringNo—Name or RGB representation of the font’s color (e.g., red or
font_familystringNo—The name of the font family.
font_sizeintegerNo—Font size in points.
font_stylestringNo—Whether to use a normal or italic font.
font_weightstringNo—Whether to use a normal or bold font.
line_spacingintegerNo—The spacing between lines of text in pixels.
opacityintegerNo—Text opacity value between 0 (invisible) and 100.
public_idstringNo—The identifier that is used for accessing the generated image. If not specified, a unique identifier is generated.
textstringYes—The text string to generate an image for.
text_alignstringNo—Text alignment (left, center, right, justify).
text_decorationstringNo—Text decoration style.

​
cloudinary_assets_update_resource_by_asset_id

Updates an existing asset’s metadata, tags, and other attributes using its asset ID Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYes—The asset ID of the resource. Must be a 32-character hexadecimal string.
access_controlobject[]No—Restricts access to the asset by specifying one or more access types. The asset is restricted unless at least one listed access type is valid.
asset_folderstringNo—The folder where the asset should be placed.
auto_taggingnumberNo—Confidence threshold for auto-tagging.
background_removalstringNo—The background removal provider to use for the resource. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges).
categorizationstringNo—The type of categorization to perform on the resource. Optionally append a language code suffix (e.g., google_tagging:fr).
clear_invalidbooleanNo—Whether to clear invalid metadata fields. If false, invalid fields will be preserved. Default: false
contextstringNo—A pipe-separated list of key-value pairs of contextual metadata.
custom_coordinatesstringNo—Custom coordinates as comma-separated values, with multiple coordinates separated by pipes.
detectionstringNo—The type of detection to perform on the resource.
display_namestringNo—The display name of the resource.
face_coordinatesstringNo—Face coordinates as comma-separated values, with multiple faces separated by pipes.
metadatastringNo—A pipe-separated list of custom metadata fields (by external_id) and their values.
moderation_statusstringNo—The moderation status of the resource.
ocrstringNo—The type of OCR to perform on the resource. Set to adv_ocr, optionally with options (e.g., adv_ocr:document).
quality_overridestringNo—Quality override value that will override any automatic quality transformations.
raw_convertstringNo—The conversion to apply for raw files (e.g., aspose, google_speech, extract_text).
regionsstringNo—Named groups of coordinate pairs representing regions.
tagsstringNo—A comma-separated list of tags to assign to the resource.
unique_display_namebooleanNo—Whether to ensure the display name is unique across all resources. If false, the operation will fail if a resource with the same display name exists. Default: false
visual_searchbooleanNo—Whether to index the resource with visual search. If true, the resource will be indexed for visual search capabilities. Default: false

​
cloudinary_assets_update_resource_by_public_id

Update asset by public ID Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource.
typestringYes—The extended storage type of the resource.
public_idstringYes—The public ID of the asset.
access_controlobject[]No—Restricts access to the asset by specifying one or more access types. The asset is restricted unless at least one listed access type is valid.
asset_folderstringNo—The folder where the asset should be placed.
auto_taggingnumberNo—Confidence threshold for auto-tagging.
background_removalstringNo—The background removal provider to use for the resource. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges).
categorizationstringNo—The type of categorization to perform on the resource. Optionally append a language code suffix (e.g., google_tagging:fr).
clear_invalidbooleanNo—Whether to clear invalid metadata fields. If false, invalid fields will be preserved. Default: false
contextstringNo—A pipe-separated list of key-value pairs of contextual metadata.
custom_coordinatesstringNo—Custom coordinates as comma-separated values, with multiple coordinates separated by pipes.
detectionstringNo—The type of detection to perform on the resource.
display_namestringNo—The display name of the resource.
face_coordinatesstringNo—Face coordinates as comma-separated values, with multiple faces separated by pipes.
metadatastringNo—A pipe-separated list of custom metadata fields (by external_id) and their values.
moderation_statusstringNo—The moderation status of the resource.
ocrstringNo—The type of OCR to perform on the resource. Set to adv_ocr, optionally with options (e.g., adv_ocr:document).
quality_overridestringNo—Quality override value that will override any automatic quality transformations.
raw_convertstringNo—The conversion to apply for raw files (e.g., aspose, google_speech, extract_text).
regionsstringNo—Named groups of coordinate pairs representing regions.
tagsstringNo—A comma-separated list of tags to assign to the resource.
unique_display_namebooleanNo—Whether to ensure the display name is unique across all resources. If false, the operation will fail if a resource with the same display name exists. Default: false
visual_searchbooleanNo—Whether to index the resource with visual search. If true, the resource will be indexed for visual search capabilities. Default: false

​
cloudinary_assets_upload

Uploads media assets (images, videos, raw files) to your Cloudinary product environment Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource to upload: - “image” for uploading strictly images - “video” for uploading strictly videos - “raw” for uploading non-media files - “auto” for allowing Cloudinary to automatically detect the type of the uploaded file
access_controlobject[]No—Restricts access to the asset by specifying one or more access types. The asset is restricted unless at least one listed access type is valid.
access_modestringNo—Allows the asset to behave as if it’s of the authenticated ‘type’ (see above) while still using the default ‘upload’ type in delivery URLs. The asset can later be made public by changing its access_mode via the Admin API, without having to update any delivery URLs. Valid values: public, and authenticated.
accessibility_analysisbooleanNo—Whether to return return accessibility analysis values for the image.
allowed_formatsstringNo—A comma-separated list of file formats that are allowed for uploading. Files of other types will be rejected. The formats can be any combination of image types, video formats or raw file extensions. Note: You can also add the format parameter to convert other file types instead of rejecting them. In this case, only files that would normally be rejected are converted, any file format allowed for upload wont be converted.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asset_folderstringNo—The asset folder to assign to the asset.
asyncbooleanNo—When set to true, returns the uploaded asset’s public_id immediately in the response, before the upload is completed (asynchronously). Default: false.
auto_chapteringbooleanNo—Whether to trigger automatic generation of video chapters. Chapters will be generated and saved as a .vtt file with -chapters appended to the public ID of the video. You can enable chapters as part of the Cloudinary Video Player. Relevant for videos only.
auto_taggingnumberNo—Automatically assigns tags to an asset according to detected objects or categories with a confidence score higher than the specified value. Use together with the detection parameter for: - Cloudinary AI Content Analysis - Amazon Rekognition Celebrity Detection Use together with the categorization parameter for: - Google Automatic Video Tagging - Google Auto Tagging - Imagga Auto Tagging - Amazon Rekognition Auto Tagging
auto_transcriptionobjectNo—Auto Transcription
background_removalstringNo—Automatically remove the background of an image using an add-on. - Set to cloudinary_ai to use the deep-learning based Cloudinary AI Background Removal add-on. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges). - Note: this feature has been superseded by background removal on the fly. - Set to pixelz to use the human-powered Pixelz Remove-The-Background Editing add-on service. Relevant for images only.
backupbooleanNo—Whether to backup the uploaded asset. When set to true, backs up uploaded assets to a secondary storage bucket.
callbackstringNo—A URL to redirect to after the upload/explicit is completed instead of returning the upload response. Signed upload result parameters are added to the callback URL. This parameter is ignored for XHR (Ajax XMLHttpRequest) or JavaScript Fetch API upload requests. Note: This parameter is relevant for direct uploads from a form in the browser. It is automatically set if you perform direct upload from the browser using Cloudinary’s SDKs and the jQuery plugin.
categorizationstringNo—A comma-separated list of the categorization add-ons to run on the asset. Set to google_tagging, google_video_tagging, imagga_tagging and/or aws_rek_tagging to automatically classify the scenes of the uploaded asset. Optionally append a language code suffix (e.g., google_tagging:fr).
cinemagraph_analysisbooleanNo—Whether to return a cinemagraph analysis value for the media asset between 0 and 1, where 0 means the asset is not a cinemagraph and 1 means the asset is a cinemagraph. Relevant for animated images and video only. A static image will return 0.
colorsbooleanNo—Whether to retrieve predominant colors & color histogram of the uploaded image. Note: If all returned colors are opaque, then 6-digit RGB hex values are returned. If one or more colors contain an alpha channel, then 8-digit RGBA hex quadruplet values are returned.
contextstringNo—Key-value pairs of general textual context metadata to attach to the asset.
custom_coordinatesstringNo—An array of coordinates for custom cropping.
detectionstringNo—Invokes the relevant add-on to return a list of detected content. Set to: - <content-aware model>_[<version>] (e.g. coco_v2) to return a list of detected content using the Cloudinary AI Content Analysis add-on. Can be used together with the auto_tagging parameter to apply tags automatically. - captioning to analyze an image and suggest a caption based on the image’s contents. - iqa to analyze the quality of an image. - watermark-detection to detect watermarks in an image. - adv_face to return a list of facial attributes using the Advanced Facial Attribute Detection add-on. - aws_rek_face to return a list of detected celebrities and facial attributes using the Amazon Rekognition Celebrity Detection add-on. Can be used together with the auto_tagging parameter to apply tags automatically.
discard_original_filenamebooleanNo—Whether to discard the name of the original uploaded file. Relevant when delivering assets as attachments (setting the flag disposition:attachment in delivery URLs).
display_namestringNo—A display name for the asset.
eagerstringNo—A list of transformations to eagerly generate for the asset. Accepts either a single transformation or a pipe-separated list of transformations.
eager_asyncbooleanNo—Whether to generate the eager transformations asynchronously in the background after the upload request is completed rather than before the upload is completed.
eager_notification_urlstringNo—A URL to notify when eager transformations are completed.
evalScriptstringNo—Allows you to modify upload parameters by specifying custom logic with JavaScript. This can be useful for conditionally adding tags, contextual metadata, structured metadata or eager transformations depending on specific criteria of the uploaded file.
face_coordinatesstringNo—An array of coordinates representing detected faces in the asset, used for custom cropping or overlays.
facesbooleanNo—Whether to detect faces in the asset.
filestringNo—One of the following: - The remote HTTP or HTTPS URL address of an existing file. - The Data URI (Base64 encoded), max ~60 MB (62,910,000 chars). - The FTP address of an existing file. - Local file path starting with file://.
filename_overridestringNo—Overrides the originally uploaded asset’s file name in downloads that use flags like fl_attachment or fl_force_original.
folderstringNo—Folder name where the uploaded asset will be stored. This parameter applies when using the Admin API, or when specifying the upload preset for unsigned uploading with the Upload API.
formatstringNo—An optional format to convert the uploaded asset to before saving in the cloud.
headersstringNo—An HTTP header or a list of headers lines for adding as response HTTP headers when delivering the asset to your users. Supported headers: Link, Authorization, X-Robots-Tag.
invalidatebooleanNo—Whether to invalidate CDN cache copies of a previously uploaded asset that shares the same public ID. Default: false.
media_metadatabooleanNo—Whether to return IPTC, XMP, and detailed Exif metadata of the uploaded asset in the response. Supported for images, video, and audio. - Returned metadata for images includes: PixelsPerUnitX, PixelsPerUnitY, PixelUnits, Colorspace, and DPI. - Returned metadata for audio and video includes: audio_codec, audio_bit_rate, audio_frequency, channels, channel_layout. - Additional metadata for video includes: pix_format, codec, level, profile, video_bit_rate, dar.
metadatastringNo—Structured metadata to attach to the asset based on the metadata fields defined for your account.
moderationstringNo—For all asset types, set to: - manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console. - perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on. For images only, set to: - webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on. - aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on. - duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image. For videos only, set to: - aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on. - google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on. To request multiple moderations in a single API call: - Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last. Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.
notification_urlstringNo—A URL to notify when the asset is ready.
ocrstringNo—Set to adv_ocr to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR text detection and extraction add-on. Optionally append options (e.g., adv_ocr:document).
on_successstringNo—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.
overwritebooleanNo—Whether to overwrite existing assets with the same public ID. When set to false, return immediately if an asset with the same public ID already exists. Default: true (when using unsigned upload, the default is false and cannot be changed to true).
phashbooleanNo—Whether to return the perceptual hash (pHash) on the uploaded image for image similarity detection.
proxystringNo—A proxy to use for fetching remote URLs. The format should be http://hostname:port.
public_idstringNo—The identifier that is used for accessing the uploaded asset. If not specified, a unique ID is generated automatically.
public_id_prefixstringNo—A string or path that’s automatically prepended to the public_id with a forward slash. The value can contain the same characters as the public_id including additional forward slashes. This prefix can be useful to provide context and improve the SEO of an asset’s filename in the delivery URL, but the value does not impact the location where the asset is stored.
quality_analysisbooleanNo—Whether to return a quality analysis value for the image between 0 and 1, where 0 means the image is blurry and out of focus and 1 means the image is sharp and in focus. Relevant for images only.
raw_convertstringNo—Generates a related file based on the uploaded file. - Set to aspose to automatically create a PDF or other image format from a raw Office document using the Aspose Document Conversion add-on. (Asynchronous) - Set to google_speech to instruct the Google AI Video Transcription add-on to generate an automatic transcript raw file from an uploaded video. (Asynchronous) - Set to extract_text to extract all the text from a PDF file and store it in a raw JSON file with a public ID in the format: [pdf_public_id].extract_text.json. The full URL of the generated JSON file is included in the API response. Unlike the above raw_convert options, this option doesn’t require registering for an add-on.(Synchronous) - Set to azure_video_indexer to generate AI-powered video insights from Microsoft Azure. (Asynchronous)
regionsstringNo—Regions to detect in the asset.
responsive_breakpointsobject[]No—Settings to automatically generate breakpoints for responsive images.
return_delete_tokenbooleanNo—Whether to return a deletion token in the upload response. The token can be used to delete the uploaded asset within approximately 10 minutes using an unauthenticated API call.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
tagsstringNo—A comma-separated list of tag names to assign to the asset.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
transformationstringNo—An incoming transformation to run on the uploaded asset before its storage. In contrast to eager, this parameter is applied before the file is stored.
typestringNo—The delivery type that defines if and how the uploaded asset is available for public delivery. By default, all uploaded assets are public (upload). Possible values are upload, authenticated, private or asset.
unique_display_namebooleanNo—Whether the display name should be unique.
unique_filenamebooleanNo—When set to false and used together with use_filename, if an asset with the same file name already exists, no random characters are appended to the file name. Instead, the asset is overwritten. Default: true (random characters are added to the file name if needed).
upload_presetstringNo—(Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload Presets page of the Console Settings. An upload preset may be marked as unsigned, which allows unsigned uploading directly from the browser and restricts the optional parameters to: public_id, folder, tags, context, face_coordinates, regions and custom_coordinates.
use_asset_folder_as_public_id_prefixbooleanNo—Whether to add the asset_folder value as a prefix to the public_id value (prepended with a forward slash). This ensures that the public ID path will always match the initial asset folder, and can help to retain the behavior that previously existed in fixed folder mode. However, keep in mind that even when this option is used during upload, an asset with a certain public ID path can later be moved to a completely different asset folder hierarchy without impacting the public ID. This option only ensures path matching for the initial upload. Relevant only when public_id_prefix (or folder) has not been separately specified.
use_filenamebooleanNo—Whether to use the original file name of the uploaded asset if available for the public ID. The file name is normalized and random characters are appended to ensure uniqueness if the file name already exists. Default: false.
use_filename_as_display_namebooleanNo—Whether to automatically assign the original filename of the uploaded asset as the asset’s display name. Relevant only if the display_name parameter isn’t set.
visual_searchbooleanNo—Whether to index the image for use with visual searches. Relevant for images only.

​
cloudinary_assets_upload_chunk

Upload a single chunk of a large file Parameters:
ParameterTypeRequiredDefaultDescription
resource_typestringYes—The type of resource to upload: - “image” for uploading strictly images - “video” for uploading strictly videos - “raw” for uploading non-media files - “auto” for allowing Cloudinary to automatically detect the type of the uploaded file
access_controlobject[]No—Restricts access to the asset by specifying one or more access types. The asset is restricted unless at least one listed access type is valid.
access_modestringNo—Allows the asset to behave as if it’s of the authenticated ‘type’ (see above) while still using the default ‘upload’ type in delivery URLs. The asset can later be made public by changing its access_mode via the Admin API, without having to update any delivery URLs. Valid values: public, and authenticated.
accessibility_analysisbooleanNo—Whether to return return accessibility analysis values for the image.
allowed_formatsstringNo—A comma-separated list of file formats that are allowed for uploading. Files of other types will be rejected. The formats can be any combination of image types, video formats or raw file extensions. Note: You can also add the format parameter to convert other file types instead of rejecting them. In this case, only files that would normally be rejected are converted, any file format allowed for upload wont be converted.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asset_folderstringNo—The asset folder to assign to the asset.
asyncbooleanNo—When set to true, returns the uploaded asset’s public_id immediately in the response, before the upload is completed (asynchronously). Default: false.
auto_chapteringbooleanNo—Whether to trigger automatic generation of video chapters. Chapters will be generated and saved as a .vtt file with -chapters appended to the public ID of the video. You can enable chapters as part of the Cloudinary Video Player. Relevant for videos only.
auto_taggingnumberNo—Automatically assigns tags to an asset according to detected objects or categories with a confidence score higher than the specified value. Use together with the detection parameter for: - Cloudinary AI Content Analysis - Amazon Rekognition Celebrity Detection Use together with the categorization parameter for: - Google Automatic Video Tagging - Google Auto Tagging - Imagga Auto Tagging - Amazon Rekognition Auto Tagging
auto_transcriptionobjectNo—Auto Transcription
background_removalstringNo—Automatically remove the background of an image using an add-on. - Set to cloudinary_ai to use the deep-learning based Cloudinary AI Background Removal add-on. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges). - Note: this feature has been superseded by background removal on the fly. - Set to pixelz to use the human-powered Pixelz Remove-The-Background Editing add-on service. Relevant for images only.
backupbooleanNo—Whether to backup the uploaded asset. When set to true, backs up uploaded assets to a secondary storage bucket.
callbackstringNo—A URL to redirect to after the upload/explicit is completed instead of returning the upload response. Signed upload result parameters are added to the callback URL. This parameter is ignored for XHR (Ajax XMLHttpRequest) or JavaScript Fetch API upload requests. Note: This parameter is relevant for direct uploads from a form in the browser. It is automatically set if you perform direct upload from the browser using Cloudinary’s SDKs and the jQuery plugin.
categorizationstringNo—A comma-separated list of the categorization add-ons to run on the asset. Set to google_tagging, google_video_tagging, imagga_tagging and/or aws_rek_tagging to automatically classify the scenes of the uploaded asset. Optionally append a language code suffix (e.g., google_tagging:fr).
cinemagraph_analysisbooleanNo—Whether to return a cinemagraph analysis value for the media asset between 0 and 1, where 0 means the asset is not a cinemagraph and 1 means the asset is a cinemagraph. Relevant for animated images and video only. A static image will return 0.
colorsbooleanNo—Whether to retrieve predominant colors & color histogram of the uploaded image. Note: If all returned colors are opaque, then 6-digit RGB hex values are returned. If one or more colors contain an alpha channel, then 8-digit RGBA hex quadruplet values are returned.
contextstringNo—Key-value pairs of general textual context metadata to attach to the asset.
custom_coordinatesstringNo—An array of coordinates for custom cropping.
detectionstringNo—Invokes the relevant add-on to return a list of detected content. Set to: - <content-aware model>_[<version>] (e.g. coco_v2) to return a list of detected content using the Cloudinary AI Content Analysis add-on. Can be used together with the auto_tagging parameter to apply tags automatically. - captioning to analyze an image and suggest a caption based on the image’s contents. - iqa to analyze the quality of an image. - watermark-detection to detect watermarks in an image. - adv_face to return a list of facial attributes using the Advanced Facial Attribute Detection add-on. - aws_rek_face to return a list of detected celebrities and facial attributes using the Amazon Rekognition Celebrity Detection add-on. Can be used together with the auto_tagging parameter to apply tags automatically.
discard_original_filenamebooleanNo—Whether to discard the name of the original uploaded file. Relevant when delivering assets as attachments (setting the flag disposition:attachment in delivery URLs).
display_namestringNo—A display name for the asset.
eagerstringNo—A list of transformations to eagerly generate for the asset. Accepts either a single transformation or a pipe-separated list of transformations.
eager_asyncbooleanNo—Whether to generate the eager transformations asynchronously in the background after the upload request is completed rather than before the upload is completed.
eager_notification_urlstringNo—A URL to notify when eager transformations are completed.
evalScriptstringNo—Allows you to modify upload parameters by specifying custom logic with JavaScript. This can be useful for conditionally adding tags, contextual metadata, structured metadata or eager transformations depending on specific criteria of the uploaded file.
face_coordinatesstringNo—An array of coordinates representing detected faces in the asset, used for custom cropping or overlays.
facesbooleanNo—Whether to detect faces in the asset.
filestringNo—One of the following: - The remote HTTP or HTTPS URL address of an existing file. - The Data URI (Base64 encoded), max ~60 MB (62,910,000 chars). - The FTP address of an existing file. - Local file path starting with file://.
filename_overridestringNo—Overrides the originally uploaded asset’s file name in downloads that use flags like fl_attachment or fl_force_original.
folderstringNo—Folder name where the uploaded asset will be stored. This parameter applies when using the Admin API, or when specifying the upload preset for unsigned uploading with the Upload API.
formatstringNo—An optional format to convert the uploaded asset to before saving in the cloud.
headersstringNo—An HTTP header or a list of headers lines for adding as response HTTP headers when delivering the asset to your users. Supported headers: Link, Authorization, X-Robots-Tag.
invalidatebooleanNo—Whether to invalidate CDN cache copies of a previously uploaded asset that shares the same public ID. Default: false.
media_metadatabooleanNo—Whether to return IPTC, XMP, and detailed Exif metadata of the uploaded asset in the response. Supported for images, video, and audio. - Returned metadata for images includes: PixelsPerUnitX, PixelsPerUnitY, PixelUnits, Colorspace, and DPI. - Returned metadata for audio and video includes: audio_codec, audio_bit_rate, audio_frequency, channels, channel_layout. - Additional metadata for video includes: pix_format, codec, level, profile, video_bit_rate, dar.
metadatastringNo—Structured metadata to attach to the asset based on the metadata fields defined for your account.
moderationstringNo—For all asset types, set to: - manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console. - perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on. For images only, set to: - webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on. - aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on. - duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image. For videos only, set to: - aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on. - google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on. To request multiple moderations in a single API call: - Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last. Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.
notification_urlstringNo—A URL to notify when the asset is ready.
ocrstringNo—Set to adv_ocr to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR text detection and extraction add-on. Optionally append options (e.g., adv_ocr:document).
on_successstringNo—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.
overwritebooleanNo—Whether to overwrite existing assets with the same public ID. When set to false, return immediately if an asset with the same public ID already exists. Default: true (when using unsigned upload, the default is false and cannot be changed to true).
phashbooleanNo—Whether to return the perceptual hash (pHash) on the uploaded image for image similarity detection.
proxystringNo—A proxy to use for fetching remote URLs. The format should be http://hostname:port.
public_idstringNo—The identifier that is used for accessing the uploaded asset. If not specified, a unique ID is generated automatically.
public_id_prefixstringNo—A string or path that’s automatically prepended to the public_id with a forward slash. The value can contain the same characters as the public_id including additional forward slashes. This prefix can be useful to provide context and improve the SEO of an asset’s filename in the delivery URL, but the value does not impact the location where the asset is stored.
quality_analysisbooleanNo—Whether to return a quality analysis value for the image between 0 and 1, where 0 means the image is blurry and out of focus and 1 means the image is sharp and in focus. Relevant for images only.
raw_convertstringNo—Generates a related file based on the uploaded file. - Set to aspose to automatically create a PDF or other image format from a raw Office document using the Aspose Document Conversion add-on. (Asynchronous) - Set to google_speech to instruct the Google AI Video Transcription add-on to generate an automatic transcript raw file from an uploaded video. (Asynchronous) - Set to extract_text to extract all the text from a PDF file and store it in a raw JSON file with a public ID in the format: [pdf_public_id].extract_text.json. The full URL of the generated JSON file is included in the API response. Unlike the above raw_convert options, this option doesn’t require registering for an add-on.(Synchronous) - Set to azure_video_indexer to generate AI-powered video insights from Microsoft Azure. (Asynchronous)
regionsstringNo—Regions to detect in the asset.
responsive_breakpointsobject[]No—Settings to automatically generate breakpoints for responsive images.
return_delete_tokenbooleanNo—Whether to return a deletion token in the upload response. The token can be used to delete the uploaded asset within approximately 10 minutes using an unauthenticated API call.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
tagsstringNo—A comma-separated list of tag names to assign to the asset.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
transformationstringNo—An incoming transformation to run on the uploaded asset before its storage. In contrast to eager, this parameter is applied before the file is stored.
typestringNo—The delivery type that defines if and how the uploaded asset is available for public delivery. By default, all uploaded assets are public (upload). Possible values are upload, authenticated, private or asset.
unique_display_namebooleanNo—Whether the display name should be unique.
unique_filenamebooleanNo—When set to false and used together with use_filename, if an asset with the same file name already exists, no random characters are appended to the file name. Instead, the asset is overwritten. Default: true (random characters are added to the file name if needed).
upload_presetstringNo—(Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload Presets page of the Console Settings. An upload preset may be marked as unsigned, which allows unsigned uploading directly from the browser and restricts the optional parameters to: public_id, folder, tags, context, face_coordinates, regions and custom_coordinates.
use_asset_folder_as_public_id_prefixbooleanNo—Whether to add the asset_folder value as a prefix to the public_id value (prepended with a forward slash). This ensures that the public ID path will always match the initial asset folder, and can help to retain the behavior that previously existed in fixed folder mode. However, keep in mind that even when this option is used during upload, an asset with a certain public ID path can later be moved to a completely different asset folder hierarchy without impacting the public ID. This option only ensures path matching for the initial upload. Relevant only when public_id_prefix (or folder) has not been separately specified.
use_filenamebooleanNo—Whether to use the original file name of the uploaded asset if available for the public ID. The file name is normalized and random characters are appended to ensure uniqueness if the file name already exists. Default: false.
use_filename_as_display_namebooleanNo—Whether to automatically assign the original filename of the uploaded asset as the asset’s display name. Relevant only if the display_name parameter isn’t set.
visual_searchbooleanNo—Whether to index the image for use with visual searches. Relevant for images only.

​
cloudinary_assets_upload_no_resource_type

Upload with automatic file type detection Parameters:
ParameterTypeRequiredDefaultDescription
access_controlobject[]No—Restricts access to the asset by specifying one or more access types. The asset is restricted unless at least one listed access type is valid.
access_modestringNo—Allows the asset to behave as if it’s of the authenticated ‘type’ (see above) while still using the default ‘upload’ type in delivery URLs. The asset can later be made public by changing its access_mode via the Admin API, without having to update any delivery URLs. Valid values: public, and authenticated.
accessibility_analysisbooleanNo—Whether to return return accessibility analysis values for the image.
allowed_formatsstringNo—A comma-separated list of file formats that are allowed for uploading. Files of other types will be rejected. The formats can be any combination of image types, video formats or raw file extensions. Note: You can also add the format parameter to convert other file types instead of rejecting them. In this case, only files that would normally be rejected are converted, any file format allowed for upload wont be converted.
api_keystringNo—The API key to use for the request. This is automatically computed by the Cloudinary’s SDKs.
asset_folderstringNo—The asset folder to assign to the asset.
asyncbooleanNo—When set to true, returns the uploaded asset’s public_id immediately in the response, before the upload is completed (asynchronously). Default: false.
auto_chapteringbooleanNo—Whether to trigger automatic generation of video chapters. Chapters will be generated and saved as a .vtt file with -chapters appended to the public ID of the video. You can enable chapters as part of the Cloudinary Video Player. Relevant for videos only.
auto_taggingnumberNo—Automatically assigns tags to an asset according to detected objects or categories with a confidence score higher than the specified value. Use together with the detection parameter for: - Cloudinary AI Content Analysis - Amazon Rekognition Celebrity Detection Use together with the categorization parameter for: - Google Automatic Video Tagging - Google Auto Tagging - Imagga Auto Tagging - Amazon Rekognition Auto Tagging
auto_transcriptionobjectNo—Auto Transcription
background_removalstringNo—Automatically remove the background of an image using an add-on. - Set to cloudinary_ai to use the deep-learning based Cloudinary AI Background Removal add-on. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges). - Note: this feature has been superseded by background removal on the fly. - Set to pixelz to use the human-powered Pixelz Remove-The-Background Editing add-on service. Relevant for images only.
backupbooleanNo—Whether to backup the uploaded asset. When set to true, backs up uploaded assets to a secondary storage bucket.
callbackstringNo—A URL to redirect to after the upload/explicit is completed instead of returning the upload response. Signed upload result parameters are added to the callback URL. This parameter is ignored for XHR (Ajax XMLHttpRequest) or JavaScript Fetch API upload requests. Note: This parameter is relevant for direct uploads from a form in the browser. It is automatically set if you perform direct upload from the browser using Cloudinary’s SDKs and the jQuery plugin.
categorizationstringNo—A comma-separated list of the categorization add-ons to run on the asset. Set to google_tagging, google_video_tagging, imagga_tagging and/or aws_rek_tagging to automatically classify the scenes of the uploaded asset. Optionally append a language code suffix (e.g., google_tagging:fr).
cinemagraph_analysisbooleanNo—Whether to return a cinemagraph analysis value for the media asset between 0 and 1, where 0 means the asset is not a cinemagraph and 1 means the asset is a cinemagraph. Relevant for animated images and video only. A static image will return 0.
colorsbooleanNo—Whether to retrieve predominant colors & color histogram of the uploaded image. Note: If all returned colors are opaque, then 6-digit RGB hex values are returned. If one or more colors contain an alpha channel, then 8-digit RGBA hex quadruplet values are returned.
contextstringNo—Key-value pairs of general textual context metadata to attach to the asset.
custom_coordinatesstringNo—An array of coordinates for custom cropping.
detectionstringNo—Invokes the relevant add-on to return a list of detected content. Set to: - <content-aware model>_[<version>] (e.g. coco_v2) to return a list of detected content using the Cloudinary AI Content Analysis add-on. Can be used together with the auto_tagging parameter to apply tags automatically. - captioning to analyze an image and suggest a caption based on the image’s contents. - iqa to analyze the quality of an image. - watermark-detection to detect watermarks in an image. - adv_face to return a list of facial attributes using the Advanced Facial Attribute Detection add-on. - aws_rek_face to return a list of detected celebrities and facial attributes using the Amazon Rekognition Celebrity Detection add-on. Can be used together with the auto_tagging parameter to apply tags automatically.
discard_original_filenamebooleanNo—Whether to discard the name of the original uploaded file. Relevant when delivering assets as attachments (setting the flag disposition:attachment in delivery URLs).
display_namestringNo—A display name for the asset.
eagerstringNo—A list of transformations to eagerly generate for the asset. Accepts either a single transformation or a pipe-separated list of transformations.
eager_asyncbooleanNo—Whether to generate the eager transformations asynchronously in the background after the upload request is completed rather than before the upload is completed.
eager_notification_urlstringNo—A URL to notify when eager transformations are completed.
evalScriptstringNo—Allows you to modify upload parameters by specifying custom logic with JavaScript. This can be useful for conditionally adding tags, contextual metadata, structured metadata or eager transformations depending on specific criteria of the uploaded file.
face_coordinatesstringNo—An array of coordinates representing detected faces in the asset, used for custom cropping or overlays.
facesbooleanNo—Whether to detect faces in the asset.
filestringNo—One of the following: - The remote HTTP or HTTPS URL address of an existing file. - The Data URI (Base64 encoded), max ~60 MB (62,910,000 chars). - The FTP address of an existing file. - Local file path starting with file://.
filename_overridestringNo—Overrides the originally uploaded asset’s file name in downloads that use flags like fl_attachment or fl_force_original.
folderstringNo—Folder name where the uploaded asset will be stored. This parameter applies when using the Admin API, or when specifying the upload preset for unsigned uploading with the Upload API.
formatstringNo—An optional format to convert the uploaded asset to before saving in the cloud.
headersstringNo—An HTTP header or a list of headers lines for adding as response HTTP headers when delivering the asset to your users. Supported headers: Link, Authorization, X-Robots-Tag.
invalidatebooleanNo—Whether to invalidate CDN cache copies of a previously uploaded asset that shares the same public ID. Default: false.
media_metadatabooleanNo—Whether to return IPTC, XMP, and detailed Exif metadata of the uploaded asset in the response. Supported for images, video, and audio. - Returned metadata for images includes: PixelsPerUnitX, PixelsPerUnitY, PixelUnits, Colorspace, and DPI. - Returned metadata for audio and video includes: audio_codec, audio_bit_rate, audio_frequency, channels, channel_layout. - Additional metadata for video includes: pix_format, codec, level, profile, video_bit_rate, dar.
metadatastringNo—Structured metadata to attach to the asset based on the metadata fields defined for your account.
moderationstringNo—For all asset types, set to: - manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console. - perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on. For images only, set to: - webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on. - aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on. - duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image. For videos only, set to: - aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on. - google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on. To request multiple moderations in a single API call: - Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last. Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.
notification_urlstringNo—A URL to notify when the asset is ready.
ocrstringNo—Set to adv_ocr to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR text detection and extraction add-on. Optionally append options (e.g., adv_ocr:document).
on_successstringNo—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.
overwritebooleanNo—Whether to overwrite existing assets with the same public ID. When set to false, return immediately if an asset with the same public ID already exists. Default: true (when using unsigned upload, the default is false and cannot be changed to true).
phashbooleanNo—Whether to return the perceptual hash (pHash) on the uploaded image for image similarity detection.
proxystringNo—A proxy to use for fetching remote URLs. The format should be http://hostname:port.
public_idstringNo—The identifier that is used for accessing the uploaded asset. If not specified, a unique ID is generated automatically.
public_id_prefixstringNo—A string or path that’s automatically prepended to the public_id with a forward slash. The value can contain the same characters as the public_id including additional forward slashes. This prefix can be useful to provide context and improve the SEO of an asset’s filename in the delivery URL, but the value does not impact the location where the asset is stored.
quality_analysisbooleanNo—Whether to return a quality analysis value for the image between 0 and 1, where 0 means the image is blurry and out of focus and 1 means the image is sharp and in focus. Relevant for images only.
raw_convertstringNo—Generates a related file based on the uploaded file. - Set to aspose to automatically create a PDF or other image format from a raw Office document using the Aspose Document Conversion add-on. (Asynchronous) - Set to google_speech to instruct the Google AI Video Transcription add-on to generate an automatic transcript raw file from an uploaded video. (Asynchronous) - Set to extract_text to extract all the text from a PDF file and store it in a raw JSON file with a public ID in the format: [pdf_public_id].extract_text.json. The full URL of the generated JSON file is included in the API response. Unlike the above raw_convert options, this option doesn’t require registering for an add-on.(Synchronous) - Set to azure_video_indexer to generate AI-powered video insights from Microsoft Azure. (Asynchronous)
regionsstringNo—Regions to detect in the asset.
responsive_breakpointsobject[]No—Settings to automatically generate breakpoints for responsive images.
return_delete_tokenbooleanNo—Whether to return a deletion token in the upload response. The token can be used to delete the uploaded asset within approximately 10 minutes using an unauthenticated API call.
signaturestringNo—(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
tagsstringNo—A comma-separated list of tag names to assign to the asset.
timestampintegerNo—The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary’s SDKs.
transformationstringNo—An incoming transformation to run on the uploaded asset before its storage. In contrast to eager, this parameter is applied before the file is stored.
typestringNo—The delivery type that defines if and how the uploaded asset is available for public delivery. By default, all uploaded assets are public (upload). Possible values are upload, authenticated, private or asset.
unique_display_namebooleanNo—Whether the display name should be unique.
unique_filenamebooleanNo—When set to false and used together with use_filename, if an asset with the same file name already exists, no random characters are appended to the file name. Instead, the asset is overwritten. Default: true (random characters are added to the file name if needed).
upload_presetstringNo—(Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload Presets page of the Console Settings. An upload preset may be marked as unsigned, which allows unsigned uploading directly from the browser and restricts the optional parameters to: public_id, folder, tags, context, face_coordinates, regions and custom_coordinates.
use_asset_folder_as_public_id_prefixbooleanNo—Whether to add the asset_folder value as a prefix to the public_id value (prepended with a forward slash). This ensures that the public ID path will always match the initial asset folder, and can help to retain the behavior that previously existed in fixed folder mode. However, keep in mind that even when this option is used during upload, an asset with a certain public ID path can later be moved to a completely different asset folder hierarchy without impacting the public ID. This option only ensures path matching for the initial upload. Relevant only when public_id_prefix (or folder) has not been separately specified.
use_filenamebooleanNo—Whether to use the original file name of the uploaded asset if available for the public ID. The file name is normalized and random characters are appended to ensure uniqueness if the file name already exists. Default: false.
use_filename_as_display_namebooleanNo—Whether to automatically assign the original filename of the uploaded asset as the asset’s display name. Relevant only if the display_name parameter isn’t set.
visual_searchbooleanNo—Whether to index the image for use with visual searches. Relevant for images only.