← Back to all apps

Overview

Tools Available23
CategoryDeveloper_tools

Manage, modify, and host your images & videos

Available Tools

Cloudinary provides 23 tools that can be used to interact with its services.

Asset-rename

asset-rename
Full Description

Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account

Parameters

Required
RequestBodyobject
resource_typestring

The type of resource.

Options:imagevideoraw

Asset-update

asset-update
Full Description

Updates 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.

Parameters

Required
asset_idstring

The asset ID of the resource. Must be a 32-character hexadecimal string.

ResourceUpdateRequestobject

Create-asset-relations

create-asset-relations
Full Description

Add 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.

Parameters

Required
asset_idstring

The asset ID of the resource. Must be a 32-character hexadecimal string.

RequestBodyobject

Create-folder

create-folder
Full Description

Creates a new empty folder in your Cloudinary media library

Creates a new folder at the specified path

Parameters

Required
folderstring

Delete-asset

delete-asset
Full Description

Delete 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.

Parameters

Required
requestobject

Delete-asset-relations

delete-asset-relations
Full Description

Delete 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.

Parameters

Required
asset_idstring

The asset ID of the resource. Must be a 32-character hexadecimal string.

RequestBodyobject

Delete-derived-assets

delete-derived-assets
Full Description

Delete derived resources

Deletes derived resources by derived resource ID

Parameters

Required
requestobject

Request parameters for deleting derived resources

Delete-folder

delete-folder
Full Description

Deletes an existing folder from your media library

Deletes a folder and all assets within it.

Parameters

Required
folderstring

Download-asset-backup

download-asset-backup
Full Description

Download a backup copy of an asset

Parameters

Required
asset_idstring

The asset ID of the resource. Must be a 32-character hexadecimal string.

version_idstring

The version ID of the backup to download. Must be a 32-character hexadecimal string.

Optional
api_keystring

The 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.

timestampinteger

The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.

Generate-archive

generate-archive
Full Description

Creates 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.

Parameters

Required
RequestBodyobject
resource_typestring

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.

Options:imagevideorawall

Get-asset-details

get-asset-details
Full Description

Get resource by asset ID

Returns the details of a single resource specified by its asset ID.

Parameters

Required
asset_idstring

The asset ID of the resource. Must be a 32-character hexadecimal string.

Optional
accessibility_analysisboolean

Whether to return accessibility analysis scores for the image. Default: false.

Default: False
colorsboolean

Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.

Default: False
coordinatesboolean

Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.

Default: False
derived_next_cursorstring

The cursor for the next page of derived assets when there are more derived images than max_results.

facesboolean

Whether to include a list of coordinates of detected faces. Default: false.

Default: False
max_resultsinteger

Maximum number of derived assets to return. Default: 10.

Default: 10
media_metadataboolean

Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.

Default: False
pagesboolean

Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.

Default: False
phashboolean

Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.

Default: False
quality_analysisboolean

Whether to return quality analysis scores for the image. Default: false.

Default: False
versionsboolean

Whether to include details of all the backed up versions of the asset. Default: false.

Default: False

Get-tx-reference

get-tx-reference
Full Description

Get Cloudinary transformation rules documentation from official docs

🚨 WHEN TO USE:

  • MANDATORY before creating, modifying, or discussing Cloudinary transformations
  • REQUIRED when user asks for image/video effects, resizing, cropping, filters, etc.
  • NOT needed for simple asset management (upload, list, delete, etc.)
  • ⚠️ CALL ONLY ONCE per session - documentation doesn't change, reuse the knowledge

🚨 STRICT REQUIREMENTS (when transformations are involved):

  • MUST call this tool BEFORE any transformation-related task (but only once)
  • MUST read and understand the returned documentation
  • DO NOT attempt transformations without consulting this reference
  • DO NOT make up transformation parameters
  • DO NOT guess syntax - only use documented parameters
  • DO NOT call this tool multiple times - the docs are static, remember them

This tool returns the complete, authoritative Cloudinary transformation reference that contains all valid parameters, syntax rules, and best practices.

Get-usage-details

get-usage-details
Full Description

Retrieves 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.

Parameters

Optional
datestring

List-files

list-files
Full Description

Get raw assets

Retrieves a list of raw assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Parameters

Optional
directionstring
Options:ascdesc
fieldsarray
max_resultsinteger

Maximum number of results to return (1-500).

next_cursorstring

Cursor for pagination.

prefixstring

A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.

public_idsarray

An array of public IDs to return.

start_atstring

An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.

tagsboolean

Whether to include the list of tag names assigned to each asset. Default: false

typestring

The delivery type for filtering resources in list operations.

Options:uploadprivateauthenticatedfetchlist

List-images

list-images
Full Description

Get image assets

Retrieves a list of image assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Parameters

Optional
directionstring
Options:ascdesc
fieldsarray
max_resultsinteger

Maximum number of results to return (1-500).

next_cursorstring

Cursor for pagination.

prefixstring

Find resources with a public ID prefix. Requires the `type` parameter.

public_idsarray

An array of public IDs to return.

start_atstring

Retrieve resources uploaded after this timestamp.

tagsboolean

Whether to include the list of tag names assigned to each asset. Default: false

typestring

The delivery type for filtering resources in list operations.

Options:uploadprivateauthenticatedfetchlist

List-tags

list-tags
Full Description

Retrieves 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)

Parameters

Required
resource_typestring

The type of resource.

Options:imagevideoraw
Optional
max_resultsinteger

Maximum number of results to return (1-500).

next_cursorstring

Cursor for pagination.

prefixstring

The prefix to use if you want to limit the returned tags to those that start with the specified prefix.

List-videos

list-videos
Full Description

Get video assets

Retrieves a list of video assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Parameters

Optional
directionstring
Options:ascdesc
fieldsarray
max_resultsinteger

Maximum number of results to return (1-500).

next_cursorstring

Cursor for pagination.

prefixstring

A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.

public_idsarray

An array of public IDs to return.

start_atstring

An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.

tagsboolean

Whether to include the list of tag names assigned to each asset. Default: false

typestring

The delivery type for filtering resources in list operations.

Options:uploadprivateauthenticatedfetchlist

Move-folder

move-folder
Full Description

Renames 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.

Parameters

Required
folderstring
RequestBodyobject

Search-assets

search-assets
Full Description

Provides 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

Parameters

Required
requestobject

Common parameters for resource search operations.

Search-folders

search-folders
Full Description

Searches 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.

Parameters

Optional
expressionstring

The (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_resultsinteger

Maximum number of folders to return (max 500, default 50).

Default: 50
next_cursorstring

The cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

sort_byarray

An array of key-value pairs for sorting. Each value is a key and direction (asc/desc).

Transform-asset

transform-asset
Full Description

Generate 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:

  • Called get-tx-reference tool
  • Verified all parameters exist in official docs
  • Used correct syntax (e.g., f_auto/q_auto not f_auto,q_auto)
  • Applied proper component chaining rules
  • Included crop mode when using width/height

This tool creates actual derived assets on Cloudinary using the explicit API.

Parameters

Required
publicIdstring

The public ID of the existing asset to transform

transformationsstring

VALIDATED 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.

Optional
invalidateboolean

Whether to invalidate cached versions

Default: False
resourceTypestring

The resource type of the asset

Options:imagevideoraw
Default: image

Upload-asset

upload-asset
Full Description

Uploads 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:

  • Local file paths (SDKs/MCP server only). For MCP server path MUST start with file://
  • Remote HTTP/HTTPS URLs
  • Base64 Data URIs (max ~60 MB)
  • Private storage buckets (S3 or Google Storage)
  • FTP addresses

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.

Parameters

Required
upload_requestobject
Optional
resource_typestring

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

Options:imagevideorawauto
Default: auto

Visual-search-assets

visual-search-assets
Full Description

Finds 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:

  • Provide a URL of an image
  • Specify the public ID or asset ID of an existing image
  • Provide a textual description

Parameters

Required
requestobject

Parameters for visual search operations