Cloudinary

Learn how to use Cloudinary with Composio

Overview

SLUG

CLOUDINARY

Description

Template description for cloudinary

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: 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.

Action Parameters

folder
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_CREATE_METADATA_FIELD

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

Action Parameters

allow_dynamic_list_values
boolean
datasource
object
default_disabled
boolean
default_value
integer
external_id
string
label
stringRequired
mandatory
boolean
restrictions
object
type
stringRequired
validation
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_CREATE_TRIGGER

Tool to create a new webhook trigger for a specified event type. use after configuring your webhook endpoint and choosing the event type. example: "create a trigger for uploads to https://example.com/hooks/cloudinary"

Action Parameters

event_type
stringRequired
uri
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_CREATE_UPLOAD_MAPPING

Tool to create a new upload mapping folder and url template. use when you need to dynamically map external url prefixes to a cloudinary asset folder before uploading files.

Action Parameters

folder
stringRequired
template
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_CREATE_UPLOAD_PRESET

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

Action Parameters

accessibility_analysis
boolean
allowed_formats
string
auto_tagging
number
background_removal
string
callback
categorization
string
cinemagraph_analysis
boolean
context
string
detection
string
eager
string
folder
string
moderation
string
name
string
notification_url
ocr
string
overwrite
booleanDefaults to True
proxy
quality_analysis
boolean
resource_type
stringDefaults to image
tags
string
transformation
string
unique_filename
booleanDefaults to True
unsigned
boolean
use_filename
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_DERIVED_RESOURCES

Tool to delete derived assets. use when you need to remove specific derived assets by their ids. example: "delete derived assets with ids [id1, id2]".

Action Parameters

derived_resource_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_ENTRIES_IN_METADATA_FIELD_DATASOURCE

Tool to delete datasource entries for a specified metadata field. use when you need to soft-delete (inactivate) specific entries in a field's datasource. example prompt: "delete entries ['color1','color2'] from metadata field 'color id'"

Action Parameters

external_id
stringRequired
external_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_FOLDER

Tool to delete an empty asset folder. use when the folder is confirmed empty and you need to remove it.

Action Parameters

folder
stringRequired
skip_backup
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_METADATA_FIELD

Tool to delete a metadata field by external id. use when you need to remove a metadata field that is no longer required.

Action Parameters

external_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_RESOURCES_BY_ASSET_ID

Tool to delete resources by asset ids. use when you need to permanently remove specific resources by their immutable asset ids; irreversible.

Action Parameters

asset_ids
arrayRequired
invalidate
boolean
keep_original
boolean
transformations
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_RESOURCES_BY_TAGS

Tool to delete cloudinary assets by tag. use when you need to remove all assets associated with a given tag.

Action Parameters

invalidate
boolean
keep_original
boolean
next_cursor
string
resource_type
stringDefaults to image
tag
stringRequired
transformations
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_DELETE_TRIGGER

Tool to delete a trigger (webhook notification). use when you need to remove a trigger by its id after confirming the correct id.

Action Parameters

trigger_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_ADAPTIVE_STREAMING_PROFILES

Tool to list adaptive streaming profiles. use when retrieving built-in and custom adaptive streaming profiles for delivering video via hls or dash.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_CONFIG

Tool to get product environment config details. use when you need to fetch or verify environment configuration such as folder mode.

Action Parameters

settings
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_METADATA_FIELD_BY_ID

Tool to get a single metadata field definition by external id. use after creating or updating a metadata field to fetch its full definition. example: "get metadata field definition for external id 'color id'."

Action Parameters

external_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_RESOURCES_BY_ASSET_FOLDER

Tool to list assets stored directly in a specified folder. use when you need to view assets in a specific folder without including subfolder contents.

Action Parameters

asset_folder
stringRequired
max_results
integerDefaults to 50
next_cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_RESOURCES_BY_CONTEXT

Tool to retrieve assets with a specified contextual metadata key/value. use when filtering resources by context metadata.

Action Parameters

context
boolean
direction
stringDefaults to desc
fields
string
key
stringRequired
max_results
integerDefaults to 10
metadata
boolean
moderations
boolean
next_cursor
string
resource_type
stringDefaults to image
tags
boolean
value
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_RESOURCES_IN_MODERATION

Tool to retrieve assets in a moderation queue by status. use after moderation to process pending or reviewed assets.

Action Parameters

context
boolean
direction
string
fields
string
max_results
integer
metadata
boolean
moderation_kind
stringRequired
moderations
boolean
next_cursor
string
resource_type
stringDefaults to image
status
stringRequired
tags
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_RESOURCE_BY_ASSET_ID

Get resource by asset id

Action Parameters

accessibility_analysis
boolean
asset_id
stringRequired
colors
boolean
coordinates
boolean
derived_next_cursor
string
faces
boolean
image_metadata
boolean
max_results
integer
pages
boolean
phash
boolean
quality_analysis
boolean
versions
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_RESOURCE_BY_PUBLIC_ID

Tool to get details of a single resource by public id. use when you need full asset, derived, and related info.

Action Parameters

accessibility_analysis
boolean
colors
boolean
coordinates
boolean
derived_next_cursor
string
faces
boolean
max_results
integer
media_metadata
boolean
pages
boolean
phash
boolean
public_id
stringRequired
quality_analysis
boolean
related
boolean
related_next_cursor
string
resource_type
stringRequired
type
stringRequired
versions
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_ROOT_FOLDERS

Tool to list all root folders in the product environment. use when you need to retrieve top-level asset folders.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_STREAMING_PROFILE_DETAILS

Tool to get details of a single streaming profile by name. use when you need to inspect an existing profile's configuration before making changes. example: "get details of streaming profile 'hd'."

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_TAGS

Tool to list all tags used for a specified resource type. use when you need to retrieve or page through the tags assigned to your assets.

Action Parameters

max_results
integer
next_cursor
string
prefix
string
resource_type
stringDefaults to image

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_TRANSFORMATIONS

Tool to list all transformations (named and unnamed). use when you need to retrieve transformation definitions or paginate through transformation records.

Action Parameters

max_results
integer
next_cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_TRIGGERS

Tool to list all webhook triggers for event types in your environment. use when you need to retrieve or filter existing triggers by type.

Action Parameters

event_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_UPLOAD_MAPPINGS

Tool to list all upload mappings by folder. use when you need to retrieve and paginate through upload mapping configurations, optionally filtering by folder.

Action Parameters

folder
string
max_results
integer
next_cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_GET_UPLOAD_MAPPING_DETAILS

Tool to retrieve details of a single upload mapping by folder. use when you need the url prefix template associated with a specific mapping folder.

Action Parameters

folder
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: 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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_ORDER_METADATA_FIELD_DATASOURCE

Tool to update ordering of a metadata field datasource. use when you need to reorder enum or set values for a metadata field datasource before updating assets.

Action Parameters

direction
stringRequired
external_id
stringRequired
order_by
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_PING_CLOUDINARY_SERVERS

Tool to ping cloudinary servers. use when testing api reachability and authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_RESTORE_ENTRIES_IN_METADATA_FIELD_DATASOURCE

Tool to restore previously deleted datasource entries for a metadata field. use after deleting entries to reactivate soft-deleted datasource entries.

Action Parameters

external_id
stringRequired
external_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: 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.

Action Parameters

expression
string
max_results
integer
next_cursor
string
sort_by
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_UPDATE_FOLDER

Tool to rename or move an existing asset folder. use when you need to change the folder's name or location.

Action Parameters

folder
stringRequired
to_folder
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CLOUDINARY_UPDATE_METADATA_FIELD

Tool to update a metadata field definition by external id. use when modifying an existing schema field (e.g., changing label or validation) without redefining all properties.

Action Parameters

allow_dynamic_list_values
boolean
datasource
object
default_disabled
boolean
default_value
integer
external_id
stringRequired
label
string
mandatory
boolean
restrictions
object
validation
object

Action Response

data
objectRequired
error
string
successful
booleanRequired