Asset-rename
asset-renameFull Description
Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account
Parameters
RequestBodyobjectresource_typestringThe type of resource.
imagevideorawManage, modify, and host your images & videos
Cloudinary provides 23 tools that can be used to interact with its services.
asset-renameUpdates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account
RequestBodyobjectresource_typestringThe type of resource.
imagevideorawasset-updateUpdates an existing asset's metadata, tags, and other attributes using its asset ID
Updates one or more attributes of a specified resource (asset) by its asset ID. This enables you to update details of an asset by its unique and immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. Note that you can also update many attributes of an existing asset using the explicit method, which is not rate-limited.
asset_idstringThe asset ID of the resource. Must be a 32-character hexadecimal string.
ResourceUpdateRequestobjectcreate-asset-relationsAdd related assets by asset ID
Relates an asset to other assets by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. This is a bidirectional process, meaning that the asset will also be added as a related_asset to all the other assets specified. The relation is also a one to many relationship, where the asset is related to all the assets specified, but those assets aren't also related to each other.
asset_idstringThe asset ID of the resource. Must be a 32-character hexadecimal string.
RequestBodyobjectcreate-folderCreates a new empty folder in your Cloudinary media library
Creates a new folder at the specified path
folderstringdelete-assetDelete asset by asset-id
Deletes an asset using its asset ID. This endpoint replaces the legacy /resources/by_asset_id endpoint. Returns the deletion status and asset folder information when folder decoupling is enabled.
requestobjectdelete-asset-relationsDelete asset relations by asset ID
Unrelates the asset from other assets, specified by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. This is a bidirectional process, meaning that the asset will also be removed as a related_asset from all the other assets specified.
asset_idstringThe asset ID of the resource. Must be a 32-character hexadecimal string.
RequestBodyobjectdelete-derived-assetsDelete derived resources
Deletes derived resources by derived resource ID
requestobjectRequest parameters for deleting derived resources
delete-folderDeletes an existing folder from your media library
Deletes a folder and all assets within it.
folderstringdownload-asset-backupDownload a backup copy of an asset
asset_idstringThe asset ID of the resource. Must be a 32-character hexadecimal string.
version_idstringThe version ID of the backup to download. Must be a 32-character hexadecimal string.
api_keystringThe API key to use for the request. This is automatically computed by the Cloudinary's SDKs.
signaturestring(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.
timestampintegerThe timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.
generate-archiveCreates an archive (ZIP or TGZ file) that contains a set of assets from your product environment.
Creates a downloadable ZIP or other archive format containing the specified resources.
RequestBodyobjectresource_typestringThe type of resources to include in the archive. "image" for images, "video" for videos, "raw" for non-media files, or "all" for mixed types.
imagevideorawallget-asset-detailsGet resource by asset ID
Returns the details of a single resource specified by its asset ID.
asset_idstringThe asset ID of the resource. Must be a 32-character hexadecimal string.
accessibility_analysisbooleanWhether to return accessibility analysis scores for the image. Default: false.
FalsecolorsbooleanWhether to include color information (predominant colors and histogram of 32 leading colors). Default: false.
FalsecoordinatesbooleanWhether to include previously specified custom cropping coordinates and faces coordinates. Default: false.
Falsederived_next_cursorstringThe cursor for the next page of derived assets when there are more derived images than max_results.
facesbooleanWhether to include a list of coordinates of detected faces. Default: false.
Falsemax_resultsintegerMaximum number of derived assets to return. Default: 10.
10media_metadatabooleanWhether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.
FalsepagesbooleanWhether to report the number of pages in multi-page documents (e.g., PDF). Default: false.
FalsephashbooleanWhether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.
Falsequality_analysisbooleanWhether to return quality analysis scores for the image. Default: false.
FalseversionsbooleanWhether to include details of all the backed up versions of the asset. Default: false.
Falseget-tx-referenceGet Cloudinary transformation rules documentation from official docs
🚨 WHEN TO USE:
🚨 STRICT REQUIREMENTS (when transformations are involved):
This tool returns the complete, authoritative Cloudinary transformation reference that contains all valid parameters, syntax rules, and best practices.
get-usage-detailsRetrieves comprehensive usage metrics and account statistics
A report on the status of product environment usage, including storage, credits, bandwidth, requests, number of resources, and add-on usage. No date parameter needed to get current usage statistics.
datestringlist-filesGet raw assets
Retrieves a list of raw assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
directionstringascdescfieldsarraymax_resultsintegerMaximum number of results to return (1-500).
next_cursorstringCursor for pagination.
prefixstringA public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.
public_idsarrayAn array of public IDs to return.
start_atstringAn ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.
tagsbooleanWhether to include the list of tag names assigned to each asset. Default: false
typestringThe delivery type for filtering resources in list operations.
uploadprivateauthenticatedfetchlistlist-imagesGet image assets
Retrieves a list of image assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
directionstringascdescfieldsarraymax_resultsintegerMaximum number of results to return (1-500).
next_cursorstringCursor for pagination.
prefixstringFind resources with a public ID prefix. Requires the `type` parameter.
public_idsarrayAn array of public IDs to return.
start_atstringRetrieve resources uploaded after this timestamp.
tagsbooleanWhether to include the list of tag names assigned to each asset. Default: false
typestringThe delivery type for filtering resources in list operations.
uploadprivateauthenticatedfetchlistlist-tagsRetrieves a list of tags currently applied to assets in your Cloudinary account
Retrieves a comprehensive list of all tags that exist in your product environment for assets of the specified type.
[Cloudinary Admin API documentation](https://cloudinary.com/documentation/admin_api)
resource_typestringThe type of resource.
imagevideorawmax_resultsintegerMaximum number of results to return (1-500).
next_cursorstringCursor for pagination.
prefixstringThe prefix to use if you want to limit the returned tags to those that start with the specified prefix.
list-videosGet video assets
Retrieves a list of video assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
directionstringascdescfieldsarraymax_resultsintegerMaximum number of results to return (1-500).
next_cursorstringCursor for pagination.
prefixstringA public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.
public_idsarrayAn array of public IDs to return.
start_atstringAn ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.
tagsbooleanWhether to include the list of tag names assigned to each asset. Default: false
typestringThe delivery type for filtering resources in list operations.
uploadprivateauthenticatedfetchlistmove-folderRenames or moves an entire folder (along with all assets it contains) to a new location
Renames or moves an entire folder (along with all assets it contains) to a new location within your Cloudinary media library.
folderstringRequestBodyobjectsearch-assetsProvides a powerful query interface to filter and retrieve assets and their details
Returns a list of resources matching the specified search criteria.
Uses Lucene-like query language to search by descriptive attributes (public_id, filename, folder, tags, context), file details (resource_type, format, bytes, width, height), embedded data (image_metadata), and analyzed data (face_count, colors, quality_score). Supports aggregate counts and complex Boolean expressions.
Examples: tags:shirt AND uploaded_at>1d, resource_type:image AND bytes>1mb, folder:products OR context.category:electronics
requestobjectCommon parameters for resource search operations.
search-foldersSearches for folders whose attributes match a given expression
Lists the folders that match the specified search expression. Limited to 2000 results. If no parameters are passed, returns the 50 most recently created folders in descending order of creation time.
expressionstringThe (Lucene-like) string expression specifying the search query, or an object for advanced queries. If not passed, returns all folders (up to max_results).
max_resultsintegerMaximum number of folders to return (max 500, default 50).
50next_cursorstringThe cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.
sort_byarrayAn array of key-value pairs for sorting. Each value is a key and direction (asc/desc).
transform-assetGenerate derived transformations for existing assets using Cloudinary's explicit API with eager transformations
⚠️ CRITICAL PREREQUISITES: 1. MUST call get-tx-reference tool first 2. MUST validate transformation syntax against official docs 3. MUST use only documented parameters from the reference 4. MUST follow proper URL component structure (slashes between components, commas within)
📋 VALIDATION CHECKLIST:
This tool creates actual derived assets on Cloudinary using the explicit API.
publicIdstringThe public ID of the existing asset to transform
transformationsstringVALIDATED transformation string using ONLY parameters from get-tx-reference docs. Examples: 'c_fill,w_300,h_200' or 'e_sepia/a_90'. MUST follow component rules: commas within components, slashes between components.
invalidatebooleanWhether to invalidate cached versions
FalseresourceTypestringThe resource type of the asset
imagevideorawimageupload-assetUploads media assets (images, videos, raw files) to your Cloudinary product environment
Uploads media assets (images, videos, raw files) to your Cloudinary product environment. The file is securely stored in the cloud with backup and revision history. Cloudinary automatically analyzes and saves important data about each asset, such as format, size, resolution, and prominent colors, which is indexed to enable searching on those attributes.
Supports uploading from:
The uploaded asset is immediately available for transformation and delivery upon successful upload.
Transform media files using transformation syntax in delivery URLs, which creates derived files accessible immediately without re-uploading the original.
upload_requestobjectresource_typestringThe 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
imagevideorawautoautovisual-search-assetsFinds images in your asset library based on visual similarity or content
Returns a list of resources that are visually similar to a specified image. You can provide the source image for comparison in one of three ways:
requestobjectParameters for visual search operations