Cloudinary

Overview

Cloudinary is a cloud-based media management platform for uploading, storing, transforming, and delivering images and videos via CDN. With the Cloudinary integration in SquadOS, your agents can upload files, apply advanced transformations, search assets by expression, manage folders and metadata — all programmatically, without leaving the automation flow.

• Official website: https://cloudinary.com/
• Composio documentation: docs.composio.dev/toolkits/cloudinary

Authentication

This tool uses API key (API_KEY) to connect.

Consult Composio for the required connection fields.

How to get credentials

1. Go to cloudinary.com and sign in (or create a free account).
2. In the main panel, locate the Dashboard — it displays your Cloud name, API Key, and API Secret under “Product Environment Credentials”.
3. Copy the API Key (and note the API Secret and Cloud name, as Composio may request them during connection).

Tip

Use credentials from a dedicated product environment rather than personal account credentials. Cloudinary allows you to create multiple environments, making it easy to separate production from development.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Cloudinary.
3. Click the card to open the details and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the credentials obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Note

This integration exposes 109 actions in total. The most relevant ones are listed below; see the full list in the Composio documentation.

Upload Asset

CLOUDINARY_UPLOAD_ASSET

Tool to upload media assets (images, videos, raw files) to Cloudinary. Use when you need to upload files from local storage or remote URLs. Supports both synchronous and asynchronous uploads with various transformation and analysis options.

Input parameters

Name	Type	Required	Description
file	object	No	File to upload. Either this or file_url must be provided.
file_url	string	No	URL of a remote file to upload. Cloudinary will fetch and upload the file from this URL.
public_id	string	No	Public ID to assign to the uploaded asset. If not specified, Cloudinary generates one automatically.
resource_type	string (“image” | “video” | “raw” | “auto”)	No	The type of resource to upload. Use auto for automatic detection.
folder	string	No	Folder path where the asset should be stored (e.g., images/events/2024).
tags	string	No	Comma-separated list of tags to assign to the uploaded asset.
transformation	string	No	Transformation to apply on upload (e.g., w_400,h_300,c_fill).
overwrite	boolean	No	Whether to overwrite existing assets with the same public_id. Default: false.
upload_preset	string	No	Name of an upload preset to use.
notification_url	string	No	Webhook URL to notify when the upload completes.
async	boolean	No	When true, the upload is processed asynchronously.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Upload File (Auto Detect)

CLOUDINARY_UPLOAD_FILE_AUTO_DETECT

Tool to upload files with automatic resource type detection. Use when uploading images, videos, or raw files without specifying the type. Cloudinary automatically detects whether the file is an image, video, or raw file based on its content.

Input parameters

Name	Type	Required	Description
file	string	Yes	The file to upload. Can be a URL (http/https), a local file path, or base64-encoded data URI (e.g., data:image/png;base64,...).
public_id	string	No	Public ID to assign to the uploaded asset.
folder	string	No	Folder path in your Cloudinary account to store the upload.
tags	string	No	Comma-separated list of tags to assign.
overwrite	boolean	No	Overwrite any existing asset with the same public_id.
upload_preset	string	No	Name of an upload preset to use. Upload preset settings override individual parameters.
transformation	string	No	Incoming transformation to apply on upload (e.g., c_limit,w_500).
notification_url	string	No	Webhook URL to notify when upload completes.
async	boolean	No	Process the upload asynchronously in the background.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Search Assets

CLOUDINARY_SEARCH_ASSETS

Tool to search and filter assets using powerful query expressions. Use when you need to find specific assets by resource type, tags, metadata, or other attributes with sorting and pagination support.

Input parameters

Name	Type	Required	Description
expression	string	No	The search expression. Supports exact match, wildcard match, presence, greater/less than, and range. For example: resource_type:image AND tags:kitten.
max_results	integer	No	The maximum number of results to return. Default: 50; maximum: 500.
sort_by	array	No	An array of sort objects, each with a single field and direction. Default: [{'created_at': 'desc'}].
fields	string	No	A comma-separated list of fields to include in the response.
next_cursor	string	No	The cursor value to get the next page of results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Resource by Public ID

CLOUDINARY_GET_RESOURCE_BY_PUBLIC_ID

Tool to get details of a single resource by public ID. All three of resource_type, type, and public_id must exactly match the stored asset’s values; a mismatch in any one causes lookup failure even if the asset exists under a different combination.

Input parameters

Name	Type	Required	Description
public_id	string	Yes	Public ID of the resource
resource_type	string (“image” | “video” | “raw”)	Yes	Resource type: image, video, or raw
type	string	Yes	Delivery type: upload, private, authenticated, etc.
faces	boolean	No	Include detected face coordinates
colors	boolean	No	Include color histogram and predominant colors
max_results	integer	No	Max number of derived or related assets to return (1–500)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Resource by Asset ID

CLOUDINARY_GET_RESOURCE_BY_ASSET_ID

Get resource details by immutable asset ID. Use when you have the asset_id and not the public_id.

Input parameters

Name	Type	Required	Description
asset_id	string	Yes	Unique immutable asset ID. Distinct from public_id; do not substitute public_id here.
faces	boolean	No	Include detected face coordinates
colors	boolean	No	Include color histogram and predominant colors
max_results	integer	No	Max derived assets to return (1–500)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Destroy Asset

CLOUDINARY_DESTROY_ASSET

Tool to permanently destroy a Cloudinary asset/resource by public ID. This operation is irreversible and removes the asset from Cloudinary storage.

Input parameters

Name	Type	Required	Description
public_id	string	Yes	The public ID of the asset to destroy. This operation is permanent and cannot be undone.
resource_type	string (“image” | “video” | “raw”)	No	Type of resource to destroy. Use video for both video and audio assets.
invalidate	boolean	No	Whether to invalidate CDN cached copies of the asset. Takes a few seconds to a few minutes to fully propagate through the CDN.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Images

CLOUDINARY_LIST_IMAGES

Tool to list image assets from Cloudinary. Use when you need to retrieve a list of image resources, with optional filtering by prefix, tags, or public IDs. Supports pagination for large result sets.

Input parameters

Name	Type	Required	Description
type	string	No	Storage type for assets.
prefix	string	No	Find resources with a public ID prefix. Requires the type parameter to be set.
public_ids	array	No	List of public IDs to return.
tags	boolean	No	Whether to include the list of tag names assigned to each asset. Default: false
max_results	integer	No	Maximum number of results to return (1–500).
next_cursor	string	No	Cursor for pagination.
direction	string (“asc” | “desc”)	No	Sort direction for results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Video Assets

CLOUDINARY_LIST_VIDEOS

Tool to list video assets from Cloudinary. Use when you need to retrieve video assets with optional filtering by prefix, public IDs, tags, or timestamps.

Input parameters

Name	Type	Required	Description
type	string	No	The storage type of the video assets. Necessary for prefix filtering.
prefix	string	No	A public_id prefix. When specified, all videos with that prefix are returned. The type parameter must also be specified.
public_ids	array	No	An array of public IDs to return.
tags	boolean	No	Whether to include the list of tag names assigned to each asset. Default: false
max_results	integer	No	Maximum number of results to return (1–500).
next_cursor	string	No	Cursor for pagination.
direction	string (“asc” | “desc”)	No	Sort direction.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Raw Files

CLOUDINARY_LIST_RAW_FILES

Tool to list raw assets from Cloudinary. Use when you need to retrieve raw files with optional filtering by prefix, tags, or public IDs.

Input parameters

Name	Type	Required	Description
type	string	No	Storage type of the assets.
prefix	string	No	A public_id prefix. When specified, all assets with that prefix are returned. The type parameter must also be specified.
public_ids	array	No	An array of public IDs to return.
tags	boolean	No	Whether to include the list of tag names assigned to each asset. Default: false
max_results	integer	No	Maximum number of results to return (1–500).
next_cursor	string	No	Cursor for pagination.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Folder

CLOUDINARY_CREATE_FOLDER

Tool to create a new asset folder. Use when you need to organize assets into nested directories. Use after confirming the folder path does not already exist.

Input parameters

Name	Type	Required	Description
folder	string	Yes	Full path of the new asset folder (e.g., images/events/2024).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Folder

CLOUDINARY_DELETE_FOLDER

Tool to delete an empty Cloudinary folder. The folder must be empty before deletion.

Input parameters

Name	Type	Required	Description
folder	string	Yes	Full path of the folder to delete. The folder must be empty.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Search Folders

CLOUDINARY_SEARCH_FOLDERS

Tool to search asset folders with filtering, sorting, and pagination. Use when you need to locate specific folders by name, path, or creation date.

Input parameters

Name	Type	Required	Description
expression	string	No	Lucene-like search expression to filter folders. For example: name:sample AND created_at>1w.
max_results	integer	No	Maximum number of folders to return (1–500). Default is 50.
sort_by	array	No	List of sort objects, each with a single field and direction. Format: [{'field':'direction'}].
next_cursor	string	No	Cursor for next page of results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Transformation

CLOUDINARY_CREATE_TRANSFORMATION

Tool to create a new named transformation by assigning a custom name to a set of transformation parameters. Use when you need to save and reuse a transformation configuration with a memorable name.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the transformation to create.
transformation	string	Yes	A valid transformation string defining the set of transformations to apply (e.g., w_100,h_150,c_fill,g_auto).
allowed_for_strict	boolean	No	Whether to allow this named transformation when strict transformations are enabled.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Transformation

CLOUDINARY_GET_TRANSFORMATION

Tool to retrieve details of a specific transformation. Use when you need to get information about a named transformation or transformation string, including its parameters and usage status.

Input parameters

Name	Type	Required	Description
transformation	string	Yes	The transformation identifier. Can be either a named transformation (e.g., small_profile_thumbnail) or a transformation string (e.g., w_100,h_150,c_fill,g_auto).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Explicit Resource Update

CLOUDINARY_EXPLICIT_RESOURCE

Tool to update an existing asset and/or eagerly generate derived transformations using Cloudinary’s Explicit API. Use when you need to pre-generate transformations, update metadata, move assets to new folders, or modify tags on already-uploaded resources.

Input parameters

Name	Type	Required	Description
public_id	string	Yes	Public ID of the existing resource to update or generate transformations for.
resource_type	string (“image” | “video” | “raw”)	No	Resource type: image, video, or raw. Defaults to image.
type	string	No	Delivery type of the resource: upload, private, or authenticated. Defaults to upload.
tags	array	No	List of tags to assign to the resource. Replaces existing tags.
eager	array	No	List of eager transformation strings to pre-generate for this asset.
eager_async	boolean	No	If true, eager transformations are generated asynchronously in the background.
context	object	No	Custom contextual metadata as key-value pairs.
metadata	object	No	Structured metadata fields to set on the resource.
invalidate	boolean	No	If true, invalidates the CDN cache for this asset (takes up to 1 hour).
asset_folder	string	No	New asset folder path to move the resource to (dynamic folder mode).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Update Resource by Public ID

CLOUDINARY_UPDATE_RESOURCE_BY_PUBLIC_ID

Tool to update asset properties by public ID in Cloudinary. Use when you need to modify tags, metadata, display name, or other asset properties without re-uploading.

Input parameters

Name	Type	Required	Description
public_id	string	Yes	Public ID of the asset to update.
resource_type	string (“image” | “video” | “raw”)	Yes	Type of resource: image, video, or raw.
type	string	Yes	Storage type of the resource.
tags	string	No	Comma-separated list of tags to assign to the resource.
context	string	No	Pipe-separated list of key-value pairs of contextual metadata.
metadata	string	No	Pipe-separated list of custom metadata fields (by external_id) and their values.
display_name	string	No	Display name of the resource.
asset_folder	string	No	Folder where the asset should be placed.
moderation_status	string (“approved” | “rejected”)	No	Moderation status of the resource.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Rename or Move Resource Public ID

CLOUDINARY_RENAME_RESOURCE

Tool to rename an asset’s public ID using Cloudinary’s rename endpoint. Use when reorganizing resources by changing public_id without re-uploading. Note: renaming changes URLs; optionally invalidate CDN caches.

Input parameters

Name	Type	Required	Description
from_public_id	string	Yes	Current public ID of the resource to rename.
to_public_id	string	Yes	New public ID for the resource. Can include folder path (e.g., folder/new_name).
resource_type	string (“image” | “video” | “raw”)	Yes	Resource type: image, video, or raw.
type	string	No	Current delivery type of the resource. Defaults to upload.
overwrite	boolean	No	If true, overwrites target public_id if it already exists.
invalidate	boolean	No	Whether to invalidate CDN cache for the old URL.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Generate Archive

CLOUDINARY_GENERATE_ARCHIVE

Tool to create an archive (ZIP or TGZ file) containing a set of assets from your Cloudinary environment. Use when you need to download multiple assets as a single archive file. Supports filtering by tags, public IDs, or prefixes.

Input parameters

Name	Type	Required	Description
resource_type	string (“image” | “video” | “raw” | “all”)	Yes	The type of resources to include in the archive.
tags	array	No	List of tags to filter assets for inclusion in the archive.
public_ids	array	No	List of public IDs of specific assets to include in the archive.
prefixes	array	No	List of prefixes to filter assets.
target_format	string (“zip” | “tgz”)	No	Archive file format.
async	boolean	No	Whether to generate the archive asynchronously. Default: false
notification_url	string	No	URL to receive a POST notification when the archive creation is complete.
target_public_id	string	No	Public ID to assign to the generated archive file.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Generate Sprite

CLOUDINARY_GENERATE_SPRITE

Tool to generate sprites by merging multiple images into a single large image. Use when you need to combine multiple images for efficient web delivery. Note: This API was deprecated in 2025 and may not be available in all Cloudinary accounts.

Input parameters

Name	Type	Required	Description
tag	string	No	Tag identifying the images to include in the sprite. Either tag or urls must be provided, but not both.
urls	array	No	List of URLs of images to include in the sprite. Either urls or tag must be provided, but not both.
transformation	string	No	Transformation string to apply to each image before merging into the sprite.
async	boolean	No	Set to true for asynchronous sprite generation.
notification_url	string	No	Webhook URL to notify when async sprite generation completes.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Image from Text

CLOUDINARY_CREATE_IMAGE_FROM_TEXT

Tool to create an image from text using Cloudinary’s text generation API. Use when you need to generate custom text images with specific styling options.

Input parameters

Name	Type	Required	Description
text	string	Yes	The text string to generate an image for. This is the only required field.
public_id	string	No	The identifier that is used for accessing the generated image. If not specified, a unique identifier is generated by Cloudinary.
font_family	string	No	The name of the font family to use for rendering the text.
font_size	integer	No	Font size in points. Default: 12.
font_color	string	No	Name or RGB representation of the font’s color (e.g., red or rgb:FF0000). Default: black.
font_weight	string (“normal” | “bold”)	No	Font weight options for text rendering.
background	string	No	Name or RGB representation of the background color. Default: transparent.
text_align	string (“left” | “center” | “right” | “justify”)	No	Text alignment options.
opacity	integer	No	Text opacity value between 0 and 100. Default: 100.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Visual Search Assets

CLOUDINARY_SEARCH_VISUAL_ASSETS

Tool to find images in your asset library based on visual similarity or content. Use when searching for visually similar images using an image URL, an existing asset, or a text description.

Input parameters

Name	Type	Required	Description
image_url	string	No	URL of an image to use as the search query. Find visually similar images.
text	string	No	Text description to search for semantically similar images.
image_asset_id	string	No	Asset ID of an existing Cloudinary image to use as the search query.
threshold	number	No	Similarity threshold for filtering results (0.0–1.0). Higher values return more similar results.
max_results	integer	No	Maximum number of results to return (1–500). Defaults to 50.
next_cursor	string	No	Cursor for pagination.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Usage

CLOUDINARY_GET_USAGE

Tool to get product environment usage details. Use when you need to monitor your Cloudinary account storage, bandwidth, requests, and other usage limits. Exceeding these limits can silently block uploads and other operations; check usage when operations fail unexpectedly to rule out cap exhaustion.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Ping Cloudinary Servers

CLOUDINARY_PING_CLOUDINARY_SERVERS

Tool to ping Cloudinary servers. Use when testing API reachability and authentication.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Upload Presets

CLOUDINARY_LIST_UPLOAD_PRESETS

Tool to list all upload presets configured in the account. Use when you need to retrieve and paginate through upload preset configurations.

Input parameters

Name	Type	Required	Description
order_by	string (“name” | “id” | “updated_at”)	No	Order by field for upload presets.
direction	string (“asc” | “desc”)	No	Sort direction for upload presets.
next_cursor	string	No	Cursor for pagination.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Upload Preset

CLOUDINARY_CREATE_UPLOAD_PRESET

Tool to create a new upload preset. Use when defining centralized upload options (tags, formats, transformations, etc.) before asset uploads.

Input parameters

Name	Type	Required	Description
name	string	No	Name for the new preset. If omitted, Cloudinary generates one.
folder	string	No	Folder path in your Cloudinary account to store uploads.
tags	string	No	Comma-separated list of tags to apply to uploads.
eager	string	No	Eager transformations to generate on upload (e.g., c_fill,g_face,h_150,w_150).
unsigned	boolean	No	Allow unsigned uploads using this preset.
overwrite	boolean	No	Overwrite any existing asset with the same public_id. Cannot be true when unsigned=true.
transformation	string	No	Incoming transformation to apply on upload (e.g., c_limit,w_500).
allowed_formats	string	No	Comma-separated list of allowed formats (e.g., jpg,png).
notification_url	string	No	Webhook URL to receive upload notifications.
resource_type	string (“image” | “video” | “raw”)	No	Asset type this preset applies to.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Metadata Fields

CLOUDINARY_LIST_METADATA_FIELDS

Tool to list all structured metadata fields defined in your Cloudinary product environment. Use to retrieve metadata schema definitions, optionally filtered by external IDs.

Input parameters

Name	Type	Required	Description
external_ids	array	No	The external IDs of the metadata fields to retrieve. If not provided, all metadata fields will be returned.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Metadata Field

CLOUDINARY_CREATE_METADATA_FIELD

Tool to create a new metadata field definition. Use when extending your metadata schema with new fields.

Input parameters

Name	Type	Required	Description
type	string (“string” | “integer” | “date” | “enum” | “set”)	Yes	Data type of the metadata field.
label	string	Yes	Human-readable label shown in the UI.
external_id	string	No	Unique ID for the field (max 255 chars). Auto-generated if omitted.
mandatory	boolean	No	Whether a value is required (default false).
default_value	string	No	Default value for the field. Required if mandatory=true.
datasource	object	No	Predefined list of values for enum or set metadata fields.
validation	object	No	Validation rules object, e.g. greater_than, strlen, strregex.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not