Skip to main content
Cloudinary logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 109
  • Triggers: 0
  • Slug: CLOUDINARY
  • Version: 20261101_00

Tools

Slug: CLOUDINARY_ACTIVATE_LIVE_STREAMTool to manually activate a Cloudinary live stream. Use when you need to start a live stream that is in an inactive state.

Input Parameters

string
required
The unique identifier of the live stream to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_ASSET_RELATIONS_BY_ASSET_IDTool to add related assets by asset ID. Use when you need to create relationships between assets in Cloudinary. Can relate up to 10 assets at once to a source asset.

Input Parameters

string
required
The asset ID of the resource to relate other assets to. Must be a 32-character hexadecimal string.
array
required
Relates the asset to all the assets specified in this array of up to 10 assets, specified by their asset IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_ASSET_RELATIONS_BY_PUBLIC_IDTool to create relations between assets by public ID. Use when you need to link related assets together (e.g., linking subtitles to videos, or associating images with each other). Each request can relate up to 10 assets to the primary asset.

Input Parameters

string
required
The delivery type of the primary asset (e.g., ‘upload’, ‘private’, ‘authenticated’).
string
required
The public ID of the primary asset to create relations from.
string ("image" | "video" | "raw")
required
The type of the primary resource.
array
required
List of assets to relate to the primary asset. Each asset must be specified as ‘resource_type/type/public_id’ format (e.g., ‘image/upload/sample’). Maximum 10 assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_FOLDERTool 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

string
required
Full path of the new asset folder (e.g., ‘images/events/2023’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_IMAGE_FROM_TEXTTool 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. The generated image can be customized with font, color, alignment, and other visual properties.

Input Parameters

string
required
The text string to generate an image for. This is the only required field.
integer
Text opacity value between 0 (invisible) and 100 (fully opaque). Default: 100.
integer
Font size in points. Default: 12.
string
The identifier that is used for accessing the generated image. If not specified, a unique identifier is generated by Cloudinary.
string
Name or RGB representation of the background color (e.g., ‘red’ or ‘rgb:FF0000’). Default: ‘transparent’.
string
Name or RGB representation of the font’s color (e.g., ‘red’ or ‘rgb:FF0000’). Default: ‘black’.
string ("normal" | "italic")
Font style options for text rendering.
string ("left" | "center" | "right" | "justify")
Text alignment options.
string
The name of the font family to use for rendering the text.
string ("normal" | "bold")
Font weight options for text rendering.
integer
The spacing between lines of text in pixels.
string ("none" | "underline")
Text decoration options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_LIVE_STREAMCreate a new Cloudinary live stream for a streaming session. The response includes an input URI and may include a stream key for pushing live content.

Input Parameters

string
Optional name for the live stream to help identify it.
object
required
Input configuration specifying the streaming protocol type.
integer
Maximum duration in seconds that the live stream can run before being automatically terminated. If not specified, uses the default maximum runtime.
integer
Number of seconds of inactivity before the stream is considered idle and may be terminated. If not specified, uses the default timeout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_LIVE_STREAM_OUTPUTTool to create a new live stream output configuration. Use when you need to add an output destination to an existing live stream, such as simulcasting to YouTube, Facebook, or creating an archive.

Input Parameters

string
The destination URI for the live stream output (e.g., RTMP endpoint for simulcasting).
string
Descriptive name for the live stream output.
string
required
Type of the live stream output (e.g., ‘hls’, ‘simulcast’, ‘archive’).
string
Vendor/platform for simulcast outputs (e.g., ‘youtube’, ‘facebook’, ‘twitch’).
string
Public identifier for the live stream output archive.
string
Stream key used for authenticating the live stream output.
string
required
The unique identifier of the live stream to create an output for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_METADATA_FIELDTool to create a new metadata field definition. Use when extending your metadata schema with new fields.

Input Parameters

string ("string" | "integer" | "date" | "enum" | "set")
required
Data type of the metadata field.
string
required
Human-readable label shown in the UI.
boolean
Whether a value is required (default false).
object
Predefined list of values for enum or set metadata fields.
object
Validation rules object, e.g. greater_than, strlen, strregex.
string
Unique ID for the field (max 255 chars). Auto-generated if omitted.
object
UI restrictions object, e.g., {‘readonly_ui’: True}.
string
Default value for the field. Required if mandatory=true. Use list for ‘set’.
boolean
Disable field by default for new assets (default false).
boolean
Allow dynamic additions of set values (for ‘set’ type).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_METADATA_RULETool to create a new conditional metadata rule. Use when you need to automatically populate metadata fields based on conditions. The rule applies a value to a target metadata field when a condition on another metadata field is met.

Input Parameters

string
required
Descriptive name for the metadata rule.
string
State of the rule: ‘active’ or ‘inactive’. Defaults to ‘active’ if not specified.
object
required
Action to perform when the condition is met.
integer
Position/order of the rule in the rule execution sequence.
object
required
Condition that determines when the rule should be applied.
string
required
The metadata field ID that will be modified when the rule triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_MULTI_RESOURCETool to create an animated image, video, or PDF from a set of images. Use when you need to combine multiple images into an animated format. Provide either a tag (to combine all images with that tag) or a list of URLs.

Input Parameters

string
Tag of images to include in the multi-resource creation. All images with this tag will be combined. Either tag or urls must be provided.
array
List of URLs of images to include in the multi-resource creation. Either tag or urls must be provided.
string ("gif" | "mp4" | "webm" | "pdf" | "png" | "webp")
Output format for animated multi-resource creation.
string ("image" | "video")
Resource type for multi endpoint.
string
Transformation parameters to apply to the resulting multi-resource (e.g., ‘w_200,h_150,c_fill’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_SLIDESHOWTool to create an auto-generated video slideshow from existing Cloudinary assets. Use when you need to compile multiple images or videos into a single video with transitions. The slideshow is created asynchronously; check status field or use notification_url for completion updates.

Input Parameters

array
List of tags to assign to the generated slideshow for categorization and search.
boolean
Whether to overwrite an existing slideshow with the same public_id. Default: false
string
Public ID to assign to the generated slideshow video. If not provided, Cloudinary will auto-generate one.
string
required
JSON string specification for the slideshow. Must be a stringified JSON object containing width (w), height (h), duration (du), fps, and slides array with media references. Example: ’{“w”:640,“h”:480,“du”:10,“fps”:30,“vars”:{“sdur”:3000,“tdur”:1000,“slides”:[{“media”:“i:sample”},{“media”:“i:sample_spread”}]}}’
string
Name of an upload preset to apply to the slideshow. Upload presets define default upload options.
array
List of transformation strings to apply to the generated slideshow video.
string
URL to receive a POST notification when the slideshow creation is complete. Useful for async processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_STREAMING_PROFILETool to create a new adaptive streaming profile in your Cloudinary account. Use when you need to define custom video quality settings for adaptive bitrate streaming. The profile will contain multiple representations at different resolutions and bitrates.

Input Parameters

string
required
The name of the streaming profile. Must be unique within your Cloudinary account.
string
The display name of the streaming profile for easier identification.
string
required
A JSON string containing the list of representations with transformation parameters. Each representation should include transformation parameters like width (w), height (h), crop mode (c), video codec (vc), and bitrate (br). Example: ’[{“transformation”:“w_1920,h_1080,c_limit,vc_h264,br_5m”},{“transformation”:“w_1280,h_720,c_limit,vc_h264,br_3m”}]‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_TRANSFORMATIONTool 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

string
required
The name of the transformation to create. This is the custom name that will be assigned to the transformation set.
string
required
A valid transformation string defining the set of transformations to apply (e.g., ‘w_100,h_150,c_fill,g_auto’).
boolean
Whether to allow this named transformation when strict transformations are enabled. Strict transformations prevent transformations from being dynamically applied to media assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_TRIGGERTool 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”

Input Parameters

string
required
HTTPS URL to receive webhook notifications.
string ("all" | "access_control_changed" | "bulk_refresh_auto_fetch" | "create_folder" | "delete" | "delete_by_token" | "delete_folder" | "eager" | "error" | "explode" | "generate_archive" | "info" | "invalidate_custom_cdn" | "moderation" | "moderation_summary" | "move" | "move_or_rename_asset_folder" | "multi" | "publish" | "rename" | "report" | "resource_context_changed" | "resource_display_name_changed" | "resource_metadata_changed" | "resource_tags_changed" | "restore_asset_version" | "sprite" | "upload")
required
The event type that triggers the webhook notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_UPLOAD_MAPPINGTool 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.

Input Parameters

string
required
The name of the folder to map.
string
required
The URL prefix to be mapped to the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_CREATE_UPLOAD_PRESETTool to create a new upload preset. Use when defining centralized upload options (tags, formats, transformations, etc.) before asset uploads.

Input Parameters

string
OCR add-on to apply.
string
Name for the new preset. If omitted, Cloudinary generates one.
string
Comma-separated list of tags to apply to uploads.
string
Eager transformations to generate on upload (e.g., ‘c_fill,g_face,h_150,w_150’).
string
Proxy URL for the upload request.
string
Folder path in your Cloudinary account to store uploads.
string
Context metadata in key=value|key2=value2 format.
string
Callback URL to send upload responses.
boolean
Allow unsigned uploads using this preset.
string
Detection add-on to apply (e.g., ‘adv_face’).
boolean
Overwrite any existing asset with the same public_id. Cannot be True when unsigned=True.
string ("manual" | "webpurify" | "aws_rek" | "aws_rek_video" | "perception_point" | "google_video_moderation" | "duplicate")
Type of moderation to apply (if any).
number
Confidence threshold (0.0-1.0) for auto-tagging.
boolean
Use the original filename of the uploaded asset.
string ("image" | "video" | "raw")
Asset type this preset applies to.
string
Comma-separated list of categorization add-on(s) to apply.
string
Incoming transformation to apply on upload (e.g., ‘c_limit,w_500’).
string
Comma-separated list of allowed formats (e.g., jpg,png).
boolean
Append a random suffix to the filename to avoid collisions.
string
Webhook URL to receive upload notifications.
boolean
Whether to perform quality analysis.
string ("cloudinary_ai" | "pixelz")
Background removal add-on to apply.
boolean
Whether to perform cinemagraph analysis.
boolean
Whether to perform accessibility analysis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_ASSET_RELATIONS_BY_ASSET_IDTool to delete asset relations by asset ID. Use when you need to unrelate a specific asset from other assets.

Input Parameters

string
required
The asset ID of the resource. Must be a 32-character hexadecimal string.
array
required
Unrelates the asset from all the assets specified in this array of assets, specified by their asset IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_ASSET_RELATIONS_BY_PUBLIC_IDDelete relations between a specified asset and other assets by public ID. The removal is bidirectional: the specified asset is also removed from the related assets’ relationships.

Input Parameters

string
required
The delivery type of the asset (e.g., ‘upload’, ‘private’, ‘authenticated’).
string
required
The public ID of the asset.
string ("image" | "video" | "raw")
required
The type of resource.
array
required
Unrelates the asset from all the assets specified in this array, specified as resource_type/type/public_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_DERIVED_RESOURCESTool to delete derived assets. Use when you need to remove specific derived assets by their IDs. Example: “Delete derived assets with IDs [id1, id2]”.

Input Parameters

array
required
Array of up to 100 derived resource IDs to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_ENTRIES_IN_METADATA_FIELD_DATASOURCEDelete specified datasource entries from a metadata field by their external IDs. Returned entries with no state supplied by the API are reported as active.

Input Parameters

string
required
External ID of the metadata field whose datasource entries will be deleted.
array
required
List of datasource entry external IDs to delete (inactivate).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_FOLDERTool to delete an empty asset folder. Use when the folder is confirmed empty and you need to remove it.

Input Parameters

string
required
Full path of the empty folder to delete (e.g., ‘product/test’).
boolean
Whether to delete the folder even if it contains backed up assets. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_LIVE_STREAMTool to delete a live stream from Cloudinary. Use when you need to permanently remove a live stream that is no longer needed.

Input Parameters

string
required
The unique identifier of the live stream to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_LIVE_STREAM_OUTPUTTool to delete a live stream output from Cloudinary. Use when you need to remove a specific output configuration from a live stream.

Input Parameters

string
required
The unique identifier of the live stream output to delete.
string
required
The unique identifier of the live stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_METADATA_FIELDTool to delete a metadata field by external ID. Use when you need to remove a metadata field that is no longer required.

Input Parameters

string
required
External ID of the metadata field to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_METADATA_RULETool to delete a conditional metadata rule by its ID. Use when you need to remove a metadata rule that is no longer required.

Input Parameters

string
required
The unique identifier of the metadata rule to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_RESOURCES_BY_ASSET_IDDelete Cloudinary resources by immutable asset ID, specifying 1 to 100 IDs. Options allow retaining originals, selecting derived transformations, and requesting CDN cache invalidation.

Input Parameters

array
required
Array of up to 100 immutable Cloudinary asset IDs to delete.
boolean
Whether to also invalidate CDN cache for deleted assets.
boolean
If true, only delete derived resources, keeping the original assets.
array
List of transformation strings; only delete derived resources matching these transformations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_RESOURCES_BY_PUBLIC_IDDelete Cloudinary resources by public IDs, prefix, or all resources of a specified resource and delivery type. The request can instead delete derived assets while keeping originals; backed-up assets may be recoverable.

Input Parameters

boolean
Delete all assets of the specified resource_type and type (up to 1000 original resources). Mutually exclusive with ‘public_ids’ and ‘prefix’.
string ("upload" | "private" | "authenticated" | "fetch" | "list" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
Extended storage type of the resource.
string
Delete all assets where the public ID starts with this prefix (up to 1000 original resources). Mutually exclusive with ‘public_ids’ and ‘all’.
boolean
Whether to invalidate the copies of the resource on the CDN. Takes a few seconds to a few minutes to fully propagate.
array
List of public IDs of the resources to delete. Maximum 100 resources can be deleted in a single request. Mutually exclusive with ‘prefix’ and ‘all’.
string
When a deletion request has more than 1000 resources to delete, the response includes a next_cursor value. Use this to continue deletion in the next request. Only applicable when using ‘prefix’ or ‘all’.
boolean
Whether to delete only the derived assets, keeping original assets.
string ("image" | "video" | "raw")
Type of resource to delete. Use ‘video’ for both video and audio assets.
string
Only delete derived assets matching this hash of transformation parameters. Multiple transformations can be separated by pipe character (|).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_RESOURCES_BY_TAGSDelete Cloudinary assets with a specified tag and resource type, optionally keeping originals and deleting derived assets. Deletion may be partial; use the returned cursor to continue.

Input Parameters

string
required
Name of the tag whose resources should be deleted.
boolean
If true, invalidate CDN cached copies of deleted resources.
string
Cursor for pagination when deleting more than 1000 resources.
boolean
If true, delete only derived assets and keep originals.
string ("image" | "raw" | "video")
Type of asset to delete. Use ‘video’ for both video and audio assets.
string
Comma-separated transformation hashes to delete matching derived resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_STREAMING_PROFILETool to delete a custom streaming profile or revert a built-in profile to original settings. Use when you need to remove a custom profile that is no longer needed.

Input Parameters

string
required
The name of the streaming profile to delete or revert

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_TRANSFORMATION2Tool to delete a named transformation from your Cloudinary account. Use when you need to remove a transformation that is no longer required.

Input Parameters

boolean
Invalidate derived resources generated using the deleted transformation from CDN. Set to true to clear cached versions.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_TRIGGERTool to delete a trigger (webhook notification). Use when you need to remove a trigger by its ID after confirming the correct ID.

Input Parameters

string
required
The unique identifier of the trigger (webhook) to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_UPLOAD_MAPPINGTool to delete a folder upload mapping. Use when you need to remove an existing upload mapping configuration.

Input Parameters

string
required
The folder name of the mapping to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DELETE_UPLOAD_PRESETTool to delete an upload preset from the account. Use when you need to remove an upload preset that is no longer needed.

Input Parameters

string
required
Name of the upload preset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DESTROY_ASSETTool to permanently destroy a Cloudinary asset/resource by public ID. Use when you need to permanently delete a specific asset. This operation is irreversible and removes the asset from Cloudinary storage.

Input Parameters

string
required
The public ID of the asset to destroy. This operation is permanent and cannot be undone.
boolean
Whether to invalidate CDN cached copies of the asset. Takes a few seconds to a few minutes to fully propagate through the CDN.
string ("image" | "video" | "raw")
Type of resource to destroy. Use ‘video’ for both video and audio assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_DESTROY_ASSET_BY_IDTool to delete an asset by its immutable asset ID. Use when you need to permanently remove a specific asset using its asset ID; operation is irreversible.

Input Parameters

string
required
The immutable asset ID of the resource to delete.
string
Callback URL to be notified when the deletion completes.
boolean
If true, invalidates the CDN cache for the deleted asset (takes up to 1 hour).
string
Webhook URL to notify when the deletion operation completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_EXPLICIT_RESOURCETool 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

array
List of tags to assign to the resource. Replaces existing tags.
string ("upload" | "private" | "authenticated")
Delivery type of the resource: upload, private, or authenticated. Defaults to upload.
array
List of eager transformation strings to pre-generate for this asset. Each transformation string defines width, height, crop mode, effects, etc. (e.g., ‘c_fill,w_300,h_200’).
boolean
If true, detect faces in the image and return face coordinates.
boolean
If true, extract predominant colors and color histogram.
object
Custom contextual metadata as key-value pairs (e.g., {‘alt’: ‘Mountain view’, ‘caption’: ‘Sunset’}).
object
Structured metadata fields to set on the resource. Keys are metadata field external IDs.
boolean
If true, overwrite existing derived resources with the same transformation.
string
required
Public ID of the existing resource to update or generate transformations for.
boolean
If true, invalidates the CDN cache for this asset (takes up to 1 hour).
string
Moderation kind to apply (e.g., ‘aws_rek’, ‘webpurify’, ‘manual’).
boolean
If true, eager transformations are generated asynchronously in the background. If false (default), they are generated synchronously.
string
New asset folder path to move the resource to (dynamic folder mode).
string
New display name for the asset.
string ("image" | "video" | "raw")
Resource type: image, video, or raw. Defaults to image.
string
Webhook URL to notify when eager transformations complete (used with eager_async=true).
boolean
If true, perform image quality analysis.
boolean
If true, perform accessibility analysis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_EXPLODE_RESOURCECreate derived images from the pages or frames of a multi-page resource, such as a PDF or animated image. The operation is asynchronous and may return a batch ID for tracking.

Input Parameters

string
Delivery type of the resource (e.g., ‘upload’, ‘private’, ‘authenticated’). Defaults to ‘upload’ if not specified.
string
Output format for the derived images (e.g., ‘jpg’, ‘png’, ‘webp’). If not specified, uses the original format or a default format.
string
required
Public ID of the multi-page resource to explode into separate derived images (e.g., PDF, PSD, TIFF, animated GIF).
string ("image")
Type of resource to explode. Currently only ‘image’ is supported for multi-page files (PDF, PSD, TIFF, etc.).
string
required
Transformation string that must include exactly one ‘pg_all’ parameter to extract all pages. Can be combined with other transformations like ‘pg_all,w_300,h_400’.
string
Webhook URL to notify when the asynchronous explode operation completes. The notification includes details about the generated derived images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GENERATE_ARCHIVETool 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. The archive is created asynchronously if async=true; use notification_url to receive completion notifications.

Input Parameters

string
Mode for archive creation. Use ‘create’ to always create a new archive or ‘download’ to return an existing archive if available.
array
List of tags to filter assets for inclusion in the archive. Only assets with these tags will be included.
string
Storage type of the assets to include (e.g., ‘upload’, ‘private’, ‘authenticated’).
boolean
Whether to generate the archive asynchronously. If true, the API returns immediately with archive details; the archive is created in the background. Default: false
array
List of prefixes to filter assets. Only assets with public IDs starting with these prefixes will be included.
integer
Unix timestamp indicating when the archive should expire and be automatically deleted.
array
List of public IDs of specific assets to include in the archive. Use when you want to create an archive of specific assets.
array
List of tags to assign to the generated archive file for categorization and search.
boolean
Whether to include derived versions of assets in the archive. Default: false
boolean
Whether to allow the archive to be created even if some requested assets are missing. Default: false
string ("image" | "video" | "raw" | "all")
required
The type of resources to include in the archive. Use ‘image’ for images, ‘video’ for videos, ‘raw’ for non-media files, or ‘all’ for mixed types.
string ("zip" | "tgz")
Archive file format.
boolean
Whether to flatten the folder structure in the archive. If true, all assets are placed in the root of the archive. Default: false
string
Transformation string to apply to assets before including them in the archive.
string
URL to receive a POST notification when the archive creation is complete. Useful for async processing.
string
Public ID to assign to the generated archive file. If not provided, Cloudinary will auto-generate one.
string
Asset folder path where the generated archive file should be stored.
boolean
Whether to use the original filename for assets in the archive instead of the public ID. Default: false
boolean
Whether to flatten the transformations directory structure in the archive. Default: false
boolean
Whether to skip including the transformation name in the archived asset filenames. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GENERATE_SPRITETool 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

string
Tag identifying the images to include in the sprite. Either ‘tag’ or ‘urls’ must be provided, but not both.
array
List of URLs of images to include in the sprite. Either ‘urls’ or ‘tag’ must be provided, but not both.
boolean
Set to true for asynchronous sprite generation. Useful for large numbers of images.
string ("image" | "video" | "raw")
Type of resources to include in the sprite. Defaults to ‘image’.
string
Transformation string to apply to each image before merging into the sprite.
string
Webhook URL to notify when async sprite generation completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_ADAPTIVE_STREAMING_PROFILESTool to list adaptive streaming profiles. Use when retrieving built-in and custom adaptive streaming profiles for delivering video via HLS or DASH.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_ANALYSIS_TASK_STATUSTool to get the status of an analysis task. Use when you need to check the progress or completion status of a previously submitted analysis task.

Input Parameters

string
required
The ID of the analysis task to check status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_CONFIGTool to get product environment config details. Use when you need to fetch or verify environment configuration such as folder_mode. Config values like folder_mode constrain uploads, folder creation, and preset creation — check this config before those operations to avoid mode conflicts.

Input Parameters

boolean
Whether to include the current configuration settings in the response (e.g., folder_mode).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_LIVE_STREAMTool to get details of a single live stream by ID. Use when you need to retrieve configuration, status, and metadata of an existing live stream.

Input Parameters

string
required
The unique identifier of the live stream to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_LIVE_STREAM_OUTPUTTool to get details of a single live stream output. Use when you need information about a specific output configuration for a live stream.

Input Parameters

string
required
The unique identifier of the live stream
string
required
The unique identifier of the live stream output

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_LIVE_STREAM_OUTPUTSTool to get a list of live stream outputs. Use when you need to retrieve all outputs configured for a specific live stream in Cloudinary.

Input Parameters

string
required
Unique identifier of the live stream to retrieve outputs for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_LIVE_STREAMSTool to get a list of live streams from Cloudinary. Use when you need to retrieve all configured live streams for your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_METADATA_FIELD_BY_IDTool 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’.”

Input Parameters

string
required
External ID of the metadata field to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_RESOURCE_BY_ASSET_IDGet Resource by Asset ID

Input Parameters

boolean
Include detected face coordinates
boolean
Include page count for multi-page documents
boolean
Include perceptual hash for similarity detection
boolean
Include color histogram and predominant colors
string
required
Unique immutable asset ID Distinct from public_id; do not substitute public_id here.
boolean
Include backed-up version details
boolean
Include custom crop and face coordinates
integer
Max derived assets to return (1-500)
boolean
Include IPTC, XMP, Exif metadata (returns ETag)
boolean
Include image quality analysis scores
string
Cursor for next page of derived assets Pass the cursor returned in the previous response to retrieve subsequent pages; iterate until exhausted to get all derived assets.
boolean
Include accessibility analysis scores

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_RESOURCE_BY_PUBLIC_IDGet details of a single resource by public ID, resource type, and delivery type, which must match the stored asset. Derived details and optionally related assets can be returned, with pagination.

Input Parameters

string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion" | "list")
required
Delivery type: upload, private, etc.
boolean
Include detected face coordinates
boolean
Include page count for multi-page files
boolean
Include perceptual hash for similarity detection
boolean
Include color histogram and predominant colors
Include list of related assets
boolean
Include backed-up versions of the resource
string
required
Public ID of the resource
boolean
Include custom cropping and face coordinates
integer
Max number of derived or related assets to return (1-500) Use with derived_next_cursor or related_next_cursor to page through large result sets.
string ("image" | "video" | "raw")
required
Resource type: image, video, or raw
boolean
Include IPTC, XMP, and detailed metadata (returns ETag)
boolean
Include image quality analysis scores
string
Cursor for next page of derived assets
Cursor for next page of related assets
boolean
Include accessibility analysis scores

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_RESOURCES_BY_ASSET_FOLDERTool to list assets stored directly in a specified folder. Use when you need to view assets in a specific folder without including subfolder contents.

Input Parameters

integer
Maximum number of assets to return (1-500). Defaults to 50.
string
Cursor for pagination; include to fetch the next page of results.
string
required
Name of the asset folder (case-insensitive) to list assets from. An incorrect or misspelled path returns an empty result, not an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_RESOURCES_BY_CONTEXTTool to retrieve assets with a specified contextual metadata key/value. Use when filtering resources by context metadata. Empty resources array indicates no matches, not an error. Enable context, metadata, tags, or moderations only when needed; use fields to limit payload size.

Input Parameters

string
required
Contextual metadata key to filter assets on (required). Only contextual metadata keys are valid filter criteria; structured metadata fields (returned via metadata=true) cannot be used here.
boolean
Include tag list for each asset.
string
Contextual metadata value to filter assets. If omitted, returns all assets with the given key.
string
Comma-separated list of resource fields to include in each asset.
boolean
Include contextual metadata key/value pairs for each asset.
boolean
Include structured metadata fields for each asset.
string ("desc" | "-1" | "asc" | "1")
Order by created_at date. ‘desc’ or ‘-1’ (default) for newest first, ‘asc’ or ‘1’ for oldest first.
integer
Maximum number of assets to return (1-500). Defaults to 10.
boolean
Include image moderation status for each asset.
string
Cursor for pagination; include to fetch the next page of results.
string ("image" | "raw" | "video")
Type of asset to list. Defaults to ‘image’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_RESOURCES_IN_MODERATIONTool to retrieve assets in a moderation queue by status. Use after moderation to process pending or reviewed assets.

Input Parameters

boolean
Include tags in the response.
string
Comma-separated list of fields to include in the response.
string ("pending" | "approved" | "rejected" | "queued" | "aborted")
required
Moderation status to filter by.
boolean
Include contextual metadata in the response.
boolean
Include structured metadata in the response.
string ("asc" | "desc" | "1" | "-1")
Sort direction of returned results.
integer
Maximum number of results to return (1-500).
boolean
Include asset moderation info in the response.
string
Cursor for pagination to fetch the next page.
string ("image" | "raw" | "video")
Type of resource to query; use ‘video’ for all videos and audio.
string ("manual" | "webpurify" | "aws_rek" | "aws_rek_video" | "perception_point" | "google_video_moderation" | "duplicate")
required
Moderation list type to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_ROOT_FOLDERSList top-level asset folders in the product environment. The response may include a next cursor, but this tool cannot request subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_STREAMING_PROFILE_DETAILSTool 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’.”

Input Parameters

string
required
The name of the streaming profile to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_TAGSTool 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.

Input Parameters

string
Only return tags that start with this prefix.
integer
Max number of tags to return (1-500). Default: 10.
string
Opaque cursor for pagination. Pass from prior response to get next page.
string ("image" | "video" | "raw")
The resource type to list tags for. ‘image’ (default), ‘video’ (for both video/audo), or ‘raw’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_TRANSFORMATIONTool to retrieve details of a specific transformation. Use when you need to get information about a named transformation or transformation string, including its parameters, derived resources, and usage status.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_TRANSFORMATIONSTool to list all transformations (named and unnamed). Use when you need to retrieve transformation definitions or paginate through transformation records.

Input Parameters

integer
Maximum number of transformations to return (1-500). Defaults to 10.
string
Cursor for pagination to retrieve the next set of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_TRIGGERSTool to list all webhook triggers for event types in your environment. Use when you need to retrieve or filter existing triggers by type.

Input Parameters

string
Filter triggers by a specific event type (e.g., ‘upload’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_UPLOAD_MAPPING_DETAILSTool to retrieve details of a single upload mapping by folder. Use when you need the URL prefix template associated with a specific mapping folder.

Input Parameters

string
required
Name of the upload mapping folder to retrieve details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_UPLOAD_MAPPINGSTool to list all upload mappings. Use when you need to retrieve and paginate through upload mapping configurations. For details of a specific mapping, use CLOUDINARY_GET_UPLOAD_MAPPING_DETAILS.

Input Parameters

integer
Maximum number of mappings to return (1-500). If omitted, the server default is applied.
string
Cursor for paginating through results; omit or unset to start at the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_UPLOAD_PRESETTool to retrieve details of a single upload preset by name. Use when you need to inspect an existing preset’s configuration.

Input Parameters

string
required
The name of the upload preset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_USAGETool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_GET_VIDEO_VIEWSTool to get video analytics views from Cloudinary. Use when you need to retrieve video viewing statistics including watch time, viewer location, and device information.

Input Parameters

string ("view_ended_at" | "video_duration" | "view_watch_time" | "-view_ended_at" | "-video_duration" | "-view_watch_time")
Sort order options for video views.
string
A set of conditions used to limit the results to rows that match those conditions. For example: video_public_id=skate
integer
The maximum number of results to return. Default is 10.
string
The cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_IDLE_LIVE_STREAMTool to manually idle a Cloudinary live stream. Use when you need to put an active live stream into idle state without stopping it completely.

Input Parameters

string
required
The unique identifier of the live stream to idle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_IMAGESList Cloudinary image assets with optional filtering by public ID prefix or public IDs, and pagination. Tags can be included in the returned asset details.

Input Parameters

boolean
Whether to include the list of tag names assigned to each asset. Default: false
string ("upload" | "private" | "authenticated" | "fetch" | "list")
Storage type for assets.
array
List of fields to include in the response. Note: public_id and asset_id are always included.
string
Find resources with a public ID prefix. Requires the type parameter to be set.
string
Retrieve resources uploaded after this timestamp (ISO8601 format).
string ("asc" | "desc")
Sort direction for results.
array
List of public IDs to return. Use to fetch specific images.
integer
Maximum number of results to return (1-500).
string
Cursor for pagination. Include this to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_METADATA_FIELDSTool 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

array
The external IDs of the metadata fields to retrieve. If not provided, all metadata fields will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_METADATA_RULESTool to retrieve all conditional metadata rules defined in your Cloudinary account. Use when you need to list or audit metadata rules that automatically apply values to assets based on conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RAW_FILESList raw assets from Cloudinary with optional filtering by prefix or public IDs. The results can include assigned tags.

Input Parameters

boolean
Whether to include the list of tag names assigned to each asset. Default: false
string ("upload" | "private" | "authenticated" | "fetch" | "list")
Storage type of the assets.
array
A comma-separated list of fields to include in the response. The following fields are always included: public_id, and asset_id.
string
A public_id prefix. When specified, all assets with that prefix are returned. When using this, the type parameter must also be specified.
string
An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither prefix nor public_ids were passed.
string ("asc" | "desc")
Sort direction for results.
array
An array of public IDs to return.
integer
Maximum number of results to return (1-500).
string
Cursor for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RESOURCES_BY_ASSET_IDSTool to retrieve multiple resources by their asset IDs. Use when you need to fetch details for multiple specific assets (up to 100) by their immutable asset IDs.

Input Parameters

array
Optional comma-separated list of fields to include in the response. Fields public_id and asset_id are always included.
array
required
List of asset IDs to retrieve. Maximum 100 asset IDs allowed.
integer
Maximum number of resources to return. Default: 10, max: 500.
string
Cursor for fetching the next page of results.
string ("image" | "video" | "raw")
Resource type for filtering results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RESOURCES_BY_EXTERNAL_IDSTool to retrieve resources by their external IDs. Use when you need to fetch multiple resources using external identifiers assigned during upload.

Input Parameters

boolean
Whether to include the list of tag names assigned to each asset.
string
Comma-separated list of fields to include in the response. This parameter takes precedence over other parameters requesting details. The fields public_id and asset_id are always included.
boolean
Whether to include key-value pairs of contextual metadata associated with each asset.
boolean
Whether to include structured metadata fields and values assigned to each asset.
integer
Maximum number of resources to return. Default: 10, max: 500.
boolean
Whether to include image moderation status of each asset.
string
Cursor for fetching the next page of results.
array
required
List of external IDs for identifying the assets to retrieve.
string ("image" | "video" | "raw")
Resource type for filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RESOURCES_BY_TAGTool to list resources (assets) with a specified tag. Use when you need to retrieve assets filtered by tag value.

Input Parameters

string
required
The tag value to filter resources by (required).
string ("asc" | "desc" | "1" | "-1")
Sort order by creation date. ‘desc’ or ‘-1’ for newest first, ‘asc’ or ‘1’ for oldest first.
integer
Maximum number of resources to return (1-500). Defaults to 10.
string
Cursor for pagination; include to fetch the next page of results.
string ("image" | "video" | "raw")
Type of resources to list. Defaults to ‘image’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RESOURCES_BY_TYPETool to retrieve resources (assets) by resource type and storage type. Use when you need to list all assets of a specific type (image, video, raw) and storage method (upload, private, etc.).

Input Parameters

string ("upload" | "private" | "authenticated" | "facebook" | "twitter" | "gplus" | "instagram_name" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
The storage/delivery type: upload, private, authenticated, facebook, etc.
integer
Max number of resources to return (default: 10, max: 500).
string
Cursor value for pagination when more results exist.
string ("image" | "video" | "raw")
The type of resource: image, video, or raw.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_RESOURCE_TYPESTool to list all available resource types in your Cloudinary product environment. Use when you need to discover which resource types are available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_UPLOAD_PRESETSTool to list all upload presets configured in the account. Use when you need to retrieve and paginate through upload preset configurations. For creating a new upload preset, use CLOUDINARY_CREATE_UPLOAD_PRESET.

Input Parameters

string ("name" | "id" | "updated_at")
Order by field for upload presets.
string ("asc" | "desc")
Sort direction for upload presets.
string
Cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_LIST_VIDEOSList video assets with optional filtering by prefix, public IDs, or creation timestamp, and optionally include their tags.

Input Parameters

boolean
Whether to include the list of tag names assigned to each asset. Default: false
string ("upload" | "private" | "authenticated" | "fetch" | "list")
The storage type of the video assets. Necessary for prefix filtering.
array
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.
string
A public_id prefix. When specified, all videos with that prefix are returned. When using this, the type parameter must also be specified.
string
An ISO-8601 formatted timestamp. When specified, videos created since that timestamp are returned. Supported only if neither prefix nor public_ids were passed.
string ("asc" | "desc")
Sort direction.
array
An array of public IDs to return.
integer
Maximum number of results to return (1-500).
string
Cursor for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_MANAGE_CONTEXTAdd or update contextual metadata on existing Cloudinary assets, or remove all contextual metadata from the selected assets.

Input Parameters

string ("upload" | "private" | "authenticated")
Storage type of the assets. Defaults to ‘upload’ if not specified.
string ("add" | "remove_all")
required
Command to perform: ‘add’ adds or updates context metadata, ‘remove_all’ removes all context metadata from the specified assets.
object
Context metadata as key-value pairs to add to the assets. Required when command is ‘add’. Not used when command is ‘remove_all’.
array
required
List of public IDs of the assets to update context metadata on.
string ("image" | "video" | "raw")
Type of resource to update. Defaults to image. Use ‘video’ for both video and audio assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_ORDER_METADATA_FIELD_DATASOURCETool 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.

Input Parameters

string
required
The criteria for sorting the datasource; currently supports only ‘value’.
string ("asc" | "desc")
required
The direction for sorting: ‘asc’ (ascending) or ‘desc’ (descending).
string
required
The external ID of the metadata field whose datasource will be reordered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_PING_CLOUDINARY_SERVERSTool to ping Cloudinary servers. Use when testing API reachability and authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_PUBLISH_RESOURCESTool to publish Cloudinary assets by public IDs, prefix, or tag. Use when you need to make authenticated or private assets publicly accessible.

Input Parameters

string
Tag of resources to publish. All resources with this tag will be published. Mutually exclusive with public_ids and prefix.
string ("upload" | "private" | "authenticated")
Current delivery type of the resources to publish. Defaults to ‘upload’ if not specified.
string
Prefix of public IDs to publish. All resources with this prefix will be published. Mutually exclusive with public_ids and tag.
boolean
If true, overwrite existing published resources with the same public ID.
boolean
If true, invalidate CDN cached copies of the resources (takes up to 1 hour).
array
List of public IDs of resources to publish. Mutually exclusive with prefix and tag.
string ("image" | "video" | "raw")
Type of resource to publish. Use ‘video’ for both video and audio assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_RENAME_RESOURCETool 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

string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
Current delivery type of the resource. Defaults to ‘upload’.
string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
New delivery type for the resource. If not specified, delivery type remains unchanged.
boolean
If true, overwrites target public_id if it already exists. If false, returns error when target exists.
boolean
Whether to invalidate CDN cache for the old URL. Important: renaming changes URLs and may break existing links.
string
required
New public ID for the resource. Can include folder path (e.g., ‘folder/new_name’).
string ("image" | "video" | "raw")
required
Resource type: image, video, or raw.
string
required
Current public ID of the resource to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_REORDER_METADATA_FIELDTool to change the position of a specific metadata field. Use when you need to reorder a single metadata field to a specific position in the list.

Input Parameters

integer
required
The new position for the metadata field (0-indexed).
string
required
External ID of the metadata field to reorder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_REORDER_METADATA_FIELDSTool to reorder all metadata fields in the product environment. Use when you need to change the display order of metadata fields based on label, creation date, or external ID.

Input Parameters

string ("label" | "created_at" | "external_id")
required
The field to order metadata fields by: ‘label’ (display name), ‘created_at’ (creation timestamp), or ‘external_id’ (unique identifier).
string ("asc" | "desc")
Enum for the sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_RESTORE_ENTRIES_IN_METADATA_FIELD_DATASOURCETool to restore previously deleted datasource entries for a metadata field. Use after deleting entries to reactivate soft-deleted datasource entries.

Input Parameters

string
required
External ID of the metadata field whose datasource entries will be restored.
array
required
List of datasource entry external IDs to restore (unblock).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_RESTORE_RESOURCESTool to restore deleted Cloudinary resources by public IDs. Use when you need to recover previously deleted assets that have backups available. Only works if backups were enabled when the resources were deleted.

Input Parameters

string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
Delivery type of the resources to restore. Defaults to ‘upload’.
array
List of specific version IDs to restore for the resources. If not specified, restores the latest backed-up version.
array
required
List of public IDs of the deleted resources to restore. Resources must have backups available.
string ("image" | "video" | "raw")
Type of resource to restore. Defaults to ‘image’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_RESTORE_RESOURCES_BY_ASSET_IDSTool to restore backed up assets by asset IDs. Use when you need to restore previously backed up resources from their immutable asset IDs. The API processes each asset ID independently; some may succeed while others fail.

Input Parameters

array
List of version IDs to restore. If specified, must match the number of asset_ids exactly.
array
required
List of unique immutable asset IDs of backed up assets to restore.
string
The URL that will receive notification when restore is complete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SEARCH_ASSETSTool 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

string
A comma-separated list of fields to include in the response. This parameter takes precedence over the with_field parameter, so if you want any additional asset attributes returned, make sure to also include them in this list (e.g., tags or context). The following fields are always included in the response: public_id, asset_id, asset_folder, created_at, status, type, and resource_type.
array
An array of single-key objects mapping a field to a sort direction. Each object must contain exactly one field name mapped to ‘asc’ or ‘desc’. Default: [{‘created_at’: ‘desc’}].
array
Aggregation parameters for grouping results. Can be used to get counts or ranges for specific fields.
string
The search expression. Supports exact match, wildcard match, presence, greater/less than, and range. For example: ‘resource_type:image AND tags:kitten’. For details on building expressions, see the Search API documentation.
array
The additional fields to include in the response. Note that the fields parameter takes precedence over this parameter.
integer
The maximum number of results to return. Default - 50. Maximum - 500.
string
The cursor value to get the next page of results. Available when a previous search returned more results than max_results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SEARCH_DATASOURCE_IN_METADATA_FIELDTool to search datasource values in a metadata field. Use when looking for specific values in enum or set metadata fields.

Input Parameters

string
The term to search for. Can be any substring of the value.
object
Metadata payload for rule-based inference.
boolean
Whether to search for an exact match. Default is false.
string
required
The external ID of the metadata field to search the datasource for.
integer
The maximum number of results to return. Default is 255.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SEARCH_FOLDERSTool 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

array
List of sort objects, each with a single field and direction. Format: [{‘field’:‘direction’}], e.g. [{‘created_at’:‘desc’}]. Valid fields: name, path, created_at; directions: asc or desc.
string
Lucene-like search expression to filter folders. For example: ‘name:sample AND created_at>1w’.
integer
Maximum number of folders to return (1-500). Default is 50.
string
Cursor for next page of results, from a prior response’s next_cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SEARCH_METADATA_FIELD_DATASOURCETool to search across all metadata field datasources. Use when you need to find values across multiple metadata fields without knowing the specific field ID.

Input Parameters

string
The term to search for. Can be any substring of the value.
integer
The maximum number of results to return. Default is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SEARCH_VISUAL_ASSETSTool 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

string
Text description to search for semantically similar images.
string
URL of an image to use as the search query. Find visually similar images.
number
Similarity threshold for filtering results (0.0-1.0). Higher values return more similar results.
integer
Maximum number of results to return (1-500). Defaults to 50.
string
Cursor for pagination; include to fetch the next page of results.
string
Asset ID of an existing Cloudinary image to use as the search query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_SHOW_FOLDERTool to list sub-folders within a specified folder. Use when you need to explore folder hierarchy or list nested folders.

Input Parameters

string
required
The path of the folder to operate on, including any nested folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_ASSET_METADATATool to populate or update metadata field values on one or more Cloudinary assets. Use when you need to set structured metadata on existing assets using their public IDs.

Input Parameters

string ("upload" | "private" | "authenticated")
Storage type of the assets. Defaults to ‘upload’ if not specified.
object
required
Key-value pairs for metadata fields to set. Keys are metadata field external IDs, values are the metadata values to assign.
array
required
List of public IDs of the assets to update metadata on.
boolean
If true, remove any invalid metadata keys from the request before processing.
string ("image" | "video" | "raw")
Type of resource to update. Defaults to image. Use ‘video’ for both video and audio assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_FOLDERTool to rename or move an existing asset folder. Use when you need to change the folder’s name or location.

Input Parameters

string
required
Full path of the existing asset folder to update, e.g., ‘product/test’.
string
required
New full path of the asset folder. Changing only the last component renames, only the path moves, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_LIVE_STREAMTool to update a live stream’s configuration in Cloudinary. Use when you need to modify the name, idle timeout, or maximum runtime of an existing live stream.

Input Parameters

string
The name of the live stream.
string
required
The unique identifier of the live stream to update.
integer
Maximum runtime in seconds for the live stream. The stream will automatically stop after this duration. Set to null to remove limit.
integer
Number of seconds before the stream is considered idle and automatically stopped. Set to null to remove timeout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_LIVE_STREAM_OUTPUTTool to modify an existing live stream output configuration. Use when you need to update the name, URI, stream key, or other settings of a live stream output. Note: Default HLS and archive outputs cannot be updated; only custom simulcast outputs can be modified.

Input Parameters

string
The destination URI for the live stream output (e.g., RTMP endpoint for simulcasting).
string
Descriptive name for the live stream output.
string
Public identifier for the live stream output archive.
string
Stream key used for authenticating the live stream output.
string
required
The unique identifier of the live stream.
string
required
The unique identifier of the live stream output to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_METADATA_FIELDTool 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.

Input Parameters

string
New label for the metadata field.
boolean
Whether the field is mandatory.
object
Predefined list of values for enum or set metadata fields.
object
Validation rules for the metadata field.
string
required
External ID of the metadata field to update.
object
UI restrictions object, e.g., {‘readonly_ui’: True}.
string
Default value for the field (list for ‘set’ type).
boolean
Whether the field is disabled by default for new assets.
boolean
Allow dynamic additions of list values (for ‘set’ type).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_METADATA_FIELD_DATASOURCETool to update the datasource (allowed values) for a metadata field. Use when replacing or modifying the predefined list of values for enum or set type metadata fields.

Input Parameters

array
required
List of datasource values to set for this metadata field (replaces existing values).
string
required
External ID of the metadata field to update the datasource for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_METADATA_RULETool to update an existing conditional metadata rule. Use when you need to modify the name, condition, result, state, or position of a metadata rule.

Input Parameters

string
Descriptive name for the metadata rule.
string
State of the rule: ‘active’ or ‘inactive’.
object
Result action to perform when the condition is met.
integer
Position/order of the rule in the rule execution sequence.
object
Condition that determines when the metadata rule should be applied.
string
required
The unique identifier of the metadata rule to update.
string
The metadata field ID that will be modified when the rule triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_RESOURCE_BY_ASSET_IDTool to update asset properties by asset ID in Cloudinary. Use when you need to modify tags, metadata, display name, or other asset properties using the immutable asset ID.

Input Parameters

string ("adv_ocr")
Type of OCR to perform on the resource.
string
Comma-separated list of tags to assign to the resource.
string
Pipe-separated list of key-value pairs of contextual metadata.
string
Named groups of coordinate pairs representing regions.
string
required
The asset ID of the resource. Must be a 32-character hexadecimal string.
string
Pipe-separated list of custom metadata fields (by external_id) and their values.
string
Type of detection to perform on the resource.
string ("aspose" | "google_speech" | "extract_text")
Conversion to apply for raw files.
string
Folder where the asset should be placed.
number
Confidence threshold for auto-tagging (0 to 1).
string
Display name of the resource.
boolean
Whether to clear invalid metadata fields. If false, invalid fields are preserved. Default: false
Whether to index the resource with visual search. Default: false
array
List of access control rules restricting asset access.
string ("google_tagging" | "google_video_tagging" | "imagga_tagging" | "aws_rek_tagging")
Type of categorization to perform on the resource.
string
Face coordinates as comma-separated values, with multiple faces separated by pipes.
string
Quality override value that will override any automatic quality transformations.
string ("approved" | "rejected")
Moderation status of the resource.
string ("cloudinary_ai" | "pixelz")
Background removal provider to use for the resource.
string
Custom coordinates as comma-separated values, with multiple coordinates separated by pipes.
boolean
Whether to ensure the display name is unique across all resources. If false and a duplicate exists, the operation fails. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_RESOURCE_BY_PUBLIC_IDTool 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

string ("adv_ocr")
Type of OCR to perform on the resource.
string
Comma-separated list of tags to assign to the resource.
string ("upload" | "private" | "authenticated" | "fetch" | "list" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion")
required
Storage type of the resource.
string
Pipe-separated list of key-value pairs of contextual metadata.
string
Named groups of coordinate pairs representing regions.
string
Pipe-separated list of custom metadata fields (by external_id) and their values.
string
Type of detection to perform on the resource.
string
required
Public ID of the asset to update.
string ("aspose" | "google_speech" | "extract_text")
Conversion to apply for raw files.
string
Folder where the asset should be placed.
number
Confidence threshold for auto-tagging (0 to 1).
string
Display name of the resource.
boolean
Whether to clear invalid metadata fields. If false, invalid fields are preserved. Default: false
string ("image" | "video" | "raw")
required
Type of resource: image, video, or raw.
boolean
Whether to index the resource with visual search. Default: false
array
List of access control rules restricting asset access.
string ("google_tagging" | "google_video_tagging" | "imagga_tagging" | "aws_rek_tagging")
Type of categorization to perform.
string
Face coordinates as comma-separated values, with multiple faces separated by pipes.
string
Quality override value that will override any automatic quality transformations.
string ("approved" | "rejected")
Moderation status of the resource.
string ("cloudinary_ai" | "pixelz")
Background removal provider to use.
string
Custom coordinates as comma-separated values, with multiple coordinates separated by pipes.
boolean
Whether to ensure the display name is unique. If false and a duplicate exists, the operation fails. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_RESOURCE_TAGSTool to add, remove, replace, or remove all tags for one or more Cloudinary assets. Use when you need to manage tags on existing assets without re-uploading them. Constraint: Maximum 1000 total operations (public_ids * tags <= 1000).

Input Parameters

string
Tag(s) to add, remove, or replace. Can be a single tag string or list of tags. Not required when command is ‘remove_all’. Maximum 255 characters per tag. Note: public_ids * tags must be <= 1000 total operations.
string ("upload" | "private" | "authenticated")
Delivery type of the assets. Defaults to ‘upload’ if not specified.
string ("add" | "remove" | "remove_all" | "replace")
required
Tag operation to perform: ‘add’ adds new tags, ‘remove’ removes specific tags, ‘remove_all’ removes all tags from the assets, ‘replace’ replaces all existing tags with new ones.
array
required
List of public IDs of the assets to update. Maximum: ensure public_ids * tags <= 1000.
string ("image" | "video" | "raw")
Type of asset to update tags for. Use ‘video’ for both video and audio assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_STREAMING_PROFILETool to modify an existing adaptive streaming profile’s configuration. Use when you need to update video quality settings for an existing profile. The updated profile will contain the new representations and display name specified in the request.

Input Parameters

string
required
The name of the streaming profile to update
string
The display name of the streaming profile for easier identification.
string
required
A JSON string containing the list of representations with transformation parameters. Each representation should include transformation parameters like width (w), height (h), crop mode (c), video codec (vc), and bitrate (br). Example: ’[{“transformation”:“w_1920,h_1080,c_scale/vc_h264,br_3m”},{“transformation”:“w_1280,h_720,c_scale/vc_h264,br_2m”}]‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_TRANSFORMATION2Tool to update the definition of an existing named transformation. Use when you need to modify transformation parameters or strict mode settings for a transformation.

Input Parameters

string
Required when modifying the transformation parameters of an existing named transformation. The new transformation definition for the named transformation. Because the changed definition can be unsafe for (significantly change) assets in production, the change is applied only to newly generated derived assets that reference this named transformation. To apply the change to existing derived assets using this named transformation, invalidate them so that they’ll be regenerated with the new definition when next requested.
string
required
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’).
boolean
Whether to allow this named transformation when strict transformations are enabled. Strict transformations prevent transformations from being dynamically applied to media assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_TRIGGERTool to update the callback URL of an existing webhook trigger. Use when you need to change the notification endpoint for a trigger by its ID.

Input Parameters

string
required
The updated URL that will receive the notification response.
string
required
The unique identifier of the trigger to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_UPLOAD_MAPPINGTool to update an existing upload mapping by changing its remote URL template. Use when you need to modify the URL prefix for an existing folder mapping.

Input Parameters

string
required
The folder name of the mapping to update.
string
required
The new URL template to map to the folder. Must start with http:// or https://.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPDATE_UPLOAD_PRESETTool to update an existing upload preset’s configuration settings. Use when modifying preset options like tags, transformations, or analysis features.

Input Parameters

string
OCR add-on to apply (e.g., adv_ocr).
string
Evaluation script to run during upload.
string
required
Name of the upload preset to update.
string
Comma-separated list of tags to apply to uploads.
string
Upload type (e.g., upload, private, authenticated).
boolean
Process the upload asynchronously.
string
Eager transformations to generate on upload (e.g., ‘c_fill,g_face,h_150,w_150’).
boolean
Detect faces in the image.
boolean
Calculate perceptual hash for the asset.
string
Proxy URL for the upload request.
boolean
Create a backup of the original asset.
boolean
Extract color information from the asset.
string
Folder path in your Cloudinary account to store uploads.
string
Target format for the uploaded asset.
string
Context metadata in key=value|key2=value2 format.
string
Custom HTTP headers for delivery.
string
Geographic regions for asset distribution.
string
Callback URL to send upload responses.
string
Structured metadata fields.
boolean
Allow unsigned uploads using this preset.
string
Detection add-on to apply (e.g., adv_face).
boolean
Overwrite any existing asset with the same public_id.
string
Public ID for the uploaded asset.
boolean
Invalidate CDN cache for the asset.
string
Type of moderation to apply (e.g., manual, webpurify, aws_rek, aws_rek_video).
string
Script or action to execute on successful upload.
string
Access mode for the uploaded asset (e.g., public, authenticated).
boolean
Generate eager transformations asynchronously.
string
Conversion options for raw files.
string
Asset folder path for organizing uploads.
number
Confidence threshold (0.0-1.0) for auto-tagging.
string
Display name for the upload preset.
boolean
Use the original filename of the uploaded asset.
string
Name of another preset to chain with.
boolean
Enable visual search indexing for the asset.
array
Access control list for the asset.
string
Comma-separated list of categorization add-on(s) to apply.
boolean
Extract media metadata from the asset.
string
Incoming transformation to apply on upload (e.g., ‘c_limit,w_500’).
string
Comma-separated list of allowed file formats (e.g., jpg,png).
boolean
Enable automatic video chaptering.
boolean
Append a random suffix to the filename to avoid collisions.
string
Face coordinates for face-based cropping.
string
Webhook URL to receive upload notifications.
string
Prefix to prepend to the public_id.
boolean
Perform quality analysis on the uploaded asset.
string
Override filename for the uploaded asset.
string
Automatic transcription settings for video.
string
Background removal add-on to apply (e.g., cloudinary_ai, pixelz).
string
Custom coordinates for cropping.
boolean
Prevent specifying public_id during upload.
array
List of allowed parameters for unsigned uploads.
boolean
Return a deletion token in the response.
boolean
Ensure unique display names across assets.
boolean
Perform cinemagraph analysis on the uploaded asset.
boolean
Perform accessibility analysis on the uploaded asset.
string
Webhook URL for eager transformation notifications.
array
Configuration for responsive image breakpoints.
boolean
Discard the original filename during upload.
boolean
Use filename as display name for the asset.
boolean
Use asset folder as public_id prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPLOAD_ASSETTool 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

object
File to upload. Either this or file_url must be provided.
string
Comma-separated list of tags to assign to the uploaded asset.
boolean
When true, the upload is processed asynchronously. Returns batch_id and status immediately.
string
Comma-separated list of eager transformations to generate during upload.
boolean
Whether to detect faces in the image and include face coordinates in the response.
boolean
Whether to generate a perceptual hash for similarity detection.
boolean
Whether to extract predominant colors from the image.
string
Folder path where the asset should be stored (e.g., ‘images/events/2023’).
string
Format to convert the uploaded asset to (e.g., ‘jpg’, ‘png’, ‘webp’).
string
Context metadata in pipe-separated format (e.g., ‘alt=My Image|caption=Sunset’).
string
URL of a remote file to upload. Either this or file must be provided. Cloudinary will fetch and upload the file from this URL.
boolean
Whether to overwrite existing assets with the same public ID. Default is false.
string
Public ID to assign to the uploaded asset. If not specified, Cloudinary generates one automatically.
string
Moderation kind to apply (e.g., ‘manual’, ‘webpurify’, ‘aws_rek’).
number
Confidence threshold (0.0-1.0) for automatic tagging using AI detection.
boolean
Whether to use the original filename as the public ID (without extension). Default is false.
string ("image" | "video" | "raw" | "auto")
The type of resource to upload. ‘image’ for strictly images, ‘video’ for strictly videos, ‘raw’ for non-media files, or ‘auto’ to let Cloudinary automatically detect the file type.
string
Name of an upload preset to use. Upload presets define default upload parameters.
string
Transformation to apply on upload (e.g., ‘w_400,h_300,c_fill’).
boolean
When true and use_filename is also true, adds random characters to ensure uniqueness. Default is true.
string
Webhook URL to notify when the upload or transformation completes.
boolean
Whether to perform quality analysis on the uploaded image.
string
Background removal mode (e.g., ‘cloudinary_ai’).
boolean
Whether to perform accessibility analysis on the uploaded image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPLOAD_CHUNKUpload a single chunk of a large file to Cloudinary. Chunks of the same file must use the same upload ID; the response indicates upload progress and may include final asset details.

Input Parameters

string
OCR configuration for text extraction.
string
Evaluation script to run on upload.
string
required
The file data to upload. Must be base64-encoded with data URI scheme (e.g., ‘data:text/plain;base64,VGhpcyBpcyBhIHRlc3Q=’).
string
Comma-separated tags to assign to the asset.
string
Delivery type (e.g., ‘upload’, ‘private’, ‘authenticated’).
boolean
If true, process the upload asynchronously.
string
Eager transformations to apply immediately upon upload.
boolean
If true, detect faces in the image.
boolean
If true, calculate perceptual hash.
string
Proxy configuration.
boolean
If true, create a backup of the asset.
boolean
If true, extract predominant colors from the image.
string
Folder path where the asset should be stored.
string
Target format for the uploaded file.
string
Custom context metadata in pipe-separated key=value format (e.g., ‘caption=My photo|alt=Description’).
string
Custom headers to include in the upload.
string
Regions for analysis or processing.
string
URL for callback on upload completion.
string
Structured metadata in pipe-separated key=value format.
string
Detection configuration.
boolean
If true, overwrite existing asset with the same public ID.
string
Custom public ID for the asset.
boolean
If true, invalidate CDN cache for this asset.
string
Moderation kind to apply (e.g., ‘manual’, ‘aws_rek’).
string
Script to run on successful upload.
string
Access mode for the asset (e.g., ‘public’, ‘authenticated’).
boolean
If true, eager transformations are generated asynchronously.
string
Raw conversion configuration.
string
The asset folder path where the file should be stored.
number
Confidence threshold for automatic tagging.
string
Display name for the uploaded asset.
boolean
If true, use the original filename as the public ID.
string
required
The range of bytes being uploaded in the current chunk, in the format ‘bytes start-end/total’. For example, ‘bytes 0-999999/3000000’ indicates the first 1MB chunk of a 3MB file.
string ("image" | "video" | "raw" | "auto")
The type of resource to upload: ‘image’ for strictly images, ‘video’ for strictly videos, ‘raw’ for non-media files, or ‘auto’ to let Cloudinary detect the type automatically.
string
Name of an upload preset to use.
boolean
If true, enable visual search indexing.
array
Access control rules for the asset.
string
Categorization configuration.
boolean
If true, extract media metadata.
string
Transformation to apply on upload.
string
Comma-separated list of allowed formats.
boolean
If true, automatically generate chapters for video content.
boolean
If true, ensure the filename is unique.
string
Face coordinates for face-based cropping.
string
Webhook URL to notify on upload completion.
string
Prefix to add to the public ID.
boolean
If true, perform image quality analysis.
string
Override the filename.
string
Configuration for automatic transcription of video/audio content.
string
Background removal configuration.
string
Custom coordinates for cropping.
string
required
A unique identifier for the upload. Must be the same for all chunks of the same file.
boolean
If true, return a delete token that can be used to delete the asset.
boolean
If true, ensure the display name is unique.
boolean
If true, perform cinemagraph analysis.
boolean
If true, perform accessibility analysis on the uploaded file.
string
Webhook URL to notify when eager transformations complete.
array
Configuration for responsive breakpoints generation.
boolean
If true, discard the original filename.
boolean
If true, use the filename as the display name.
boolean
If true, use the asset folder as the public ID prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDINARY_UPLOAD_FILE_AUTO_DETECTUpload a file to Cloudinary without specifying a resource type. Optional settings let you assign a public ID, organize the asset with folders, tags and metadata, and request transformations.

Input Parameters

string
OCR add-on to apply (e.g., ‘adv_ocr’).
string
Conditional transformation logic to execute.
string
required
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,…’).
string
Comma-separated list of tags to assign to the uploaded asset.
string
Delivery type of the asset (e.g., ‘upload’, ‘private’, ‘authenticated’).
boolean
Process the upload asynchronously in the background.
string
Pipe-separated list of eager transformations to pre-generate (e.g., ‘c_fill,w_300,h_200|c_thumb,w_100,h_100’).
boolean
Detect faces in the image and return face coordinates.
boolean
Generate perceptual hash for the image.
string
Proxy URL for the upload request when uploading from a URL.
boolean
Create a backup copy of the asset.
boolean
Extract predominant colors and color histogram.
string
Folder path in your Cloudinary account to store the upload.
string
Convert the uploaded asset to this format.
string
Context metadata in pipe-separated format: key1=value1|key2=value2.
string
Custom headers to send when uploading from a URL (newline-separated).
string
Regional settings for the upload.
string
Callback URL to redirect after upload (non-XHR requests).
string
Structured metadata in pipe-separated format: field1=value1|field2=value2.
string
Detection add-on to apply (e.g., ‘adv_face’, ‘captioning’).
boolean
Overwrite any existing asset with the same public ID.
string
Public ID to assign to the uploaded asset. If not provided, Cloudinary generates one automatically.
boolean
Invalidate CDN cache for this asset (takes up to 1 hour).
string
Moderation kind to apply (e.g., ‘manual’, ‘aws_rek’, ‘webpurify’).
string
Cloudinary function to execute on successful upload.
string
Access mode for the asset (e.g., ‘public’, ‘authenticated’).
boolean
Generate eager transformations asynchronously.
string
Convert raw files using the specified conversion settings.
string
Dynamic asset folder path to organize assets (overrides folder if provided).
number
Confidence threshold (0.0-1.0) for automatic tagging.
string
Display name for the asset.
boolean
Use the original filename of the uploaded file as the public ID.
string
Name of an upload preset to use. Upload preset settings override individual parameters.
boolean
Enable visual search indexing for this asset.
string
Access control rules for the asset in JSON format (e.g., ’[{“access_type”:“token”}]’).
string
Comma-separated list of categorization add-ons to apply.
boolean
Extract embedded media metadata (EXIF, IPTC, XMP).
string
Incoming transformation to apply on upload (e.g., ‘c_limit,w_500’).
string
Comma-separated list of allowed formats. Upload will fail if file format is not in this list.
boolean
Enable automatic chaptering for video files.
boolean
Add a random suffix to the filename to avoid collisions. Default is true.
string
Face coordinates for face-based cropping.
string
Webhook URL to notify when upload completes.
string
Prefix to prepend to the public ID.
boolean
Perform image quality analysis.
string
Override the original filename.
string
Auto-transcription settings for video files in JSON format.
string
Background removal add-on to apply (e.g., ‘cloudinary_ai’, ‘pixelz’).
string
Custom coordinates for cropping in the format ‘x,y,width,height’.
boolean
Return a delete token that can be used to delete the asset within 10 minutes.
boolean
Add a random suffix to the display name to avoid collisions.
boolean
Perform cinemagraph analysis.
boolean
Perform accessibility analysis.
string
Webhook URL to notify when eager transformations complete.
string
Responsive breakpoints configuration in JSON format for generating responsive image variants.
boolean
Discard the original filename.
boolean
Use the original filename as the display name.
boolean
Use the asset folder as a prefix for the public ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not