# Cloudinary Cloudinary is a cloud-based media management platform for uploading, storing, transforming, and delivering images and videos via CDN. - **Category:** images & design - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 110 - **Triggers:** 0 - **Slug:** `CLOUDINARY` - **Version:** 20260316_00 ## Tools ### Activate Live Stream **Slug:** `CLOUDINARY_ACTIVATE_LIVE_STREAM` Tool to manually activate a Cloudinary live stream. Use when you need to start a live stream that is in an inactive state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | The unique identifier of the live stream to activate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Asset Relations by Asset ID **Slug:** `CLOUDINARY_CREATE_ASSET_RELATIONS_BY_ASSET_ID` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | The asset ID of the resource to relate other assets to. Must be a 32-character hexadecimal string. | | `assets_to_relate` | array | Yes | Relates the asset to all the assets specified in this array of up to 10 assets, specified by their asset IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Asset Relations by Public ID **Slug:** `CLOUDINARY_CREATE_ASSET_RELATIONS_BY_PUBLIC_ID` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The delivery type of the primary asset (e.g., 'upload', 'private', 'authenticated'). | | `public_id` | string | Yes | The public ID of the primary asset to create relations from. | | `resource_type` | string ("image" | "video" | "raw") | Yes | The type of the primary resource. | | `assets_to_relate` | array | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Folder **Slug:** `CLOUDINARY_CREATE_FOLDER` Tool to create a new asset folder. Use when you need to organize assets into nested directories. Use after confirming the folder path does not already exist. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | Full path of the new asset folder (e.g., 'images/events/2023'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Image from Text **Slug:** `CLOUDINARY_CREATE_IMAGE_FROM_TEXT` Tool to create an image from text using Cloudinary's text generation API. Use when you need to generate custom text images with specific styling options. The generated image can be customized with font, color, alignment, and other visual properties. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | Yes | The text string to generate an image for. This is the only required field. | | `opacity` | integer | No | Text opacity value between 0 (invisible) and 100 (fully opaque). Default: 100. | | `font_size` | integer | No | Font size in points. Default: 12. | | `public_id` | string | No | The identifier that is used for accessing the generated image. If not specified, a unique identifier is generated by Cloudinary. | | `background` | string | No | Name or RGB representation of the background color (e.g., 'red' or 'rgb:FF0000'). Default: 'transparent'. | | `font_color` | string | No | Name or RGB representation of the font's color (e.g., 'red' or 'rgb:FF0000'). Default: 'black'. | | `font_style` | string ("normal" | "italic") | No | Font style options for text rendering. | | `text_align` | string ("left" | "center" | "right" | "justify") | No | Text alignment options. | | `font_family` | string | No | The name of the font family to use for rendering the text. | | `font_weight` | string ("normal" | "bold") | No | Font weight options for text rendering. | | `line_spacing` | integer | No | The spacing between lines of text in pixels. | | `text_decoration` | string ("none" | "underline") | No | Text decoration options. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Live Stream **Slug:** `CLOUDINARY_CREATE_LIVE_STREAM` Tool to create a new live stream in Cloudinary. Use when you need to set up a new live streaming session. The created stream will provide connection details (URI and stream key) for pushing live content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional name for the live stream to help identify it. | | `input` | object | Yes | Input configuration specifying the streaming protocol type. | | `max_runtime_sec` | integer | No | Maximum duration in seconds that the live stream can run before being automatically terminated. If not specified, uses the default maximum runtime. | | `idle_timeout_sec` | integer | No | Number of seconds of inactivity before the stream is considered idle and may be terminated. If not specified, uses the default timeout. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Live Stream Output **Slug:** `CLOUDINARY_CREATE_LIVE_STREAM_OUTPUT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uri` | string | No | The destination URI for the live stream output (e.g., RTMP endpoint for simulcasting). | | `name` | string | No | Descriptive name for the live stream output. | | `type` | string | Yes | Type of the live stream output (e.g., 'hls', 'simulcast', 'archive'). | | `vendor` | string | No | Vendor/platform for simulcast outputs (e.g., 'youtube', 'facebook', 'twitch'). | | `public_id` | string | No | Public identifier for the live stream output archive. | | `stream_key` | string | No | Stream key used for authenticating the live stream output. | | `live_stream_id` | string | Yes | The unique identifier of the live stream to create an output for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Metadata Field **Slug:** `CLOUDINARY_CREATE_METADATA_FIELD` Tool to create a new metadata field definition. Use when extending your metadata schema with new fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("string" | "integer" | "date" | "enum" | "set") | Yes | Data type of the metadata field. | | `label` | string | Yes | Human-readable label shown in the UI. | | `mandatory` | boolean | No | Whether a value is required (default false). | | `datasource` | object | No | Predefined list of values for enum or set metadata fields. | | `validation` | object | No | Validation rules object, e.g. greater_than, strlen, strregex. | | `external_id` | string | No | Unique ID for the field (max 255 chars). Auto-generated if omitted. | | `restrictions` | object | No | UI restrictions object, e.g., {'readonly_ui': True}. | | `default_value` | string | No | Default value for the field. Required if mandatory=true. Use list for 'set'. | | `default_disabled` | boolean | No | Disable field by default for new assets (default false). | | `allow_dynamic_list_values` | boolean | No | Allow dynamic additions of set values (for 'set' type). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Metadata Rule **Slug:** `CLOUDINARY_CREATE_METADATA_RULE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Descriptive name for the metadata rule. | | `state` | string | No | State of the rule: 'active' or 'inactive'. Defaults to 'active' if not specified. | | `result` | object | Yes | Action to perform when the condition is met. | | `position` | integer | No | Position/order of the rule in the rule execution sequence. | | `condition` | object | Yes | Condition that determines when the rule should be applied. | | `metadata_field_id` | string | Yes | The metadata field ID that will be modified when the rule triggers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Multi-Resource Animation **Slug:** `CLOUDINARY_CREATE_MULTI_RESOURCE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | No | 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. | | `urls` | array | No | List of URLs of images to include in the multi-resource creation. Either tag or urls must be provided. | | `format` | string ("gif" | "mp4" | "webm" | "pdf" | "png" | "webp") | No | Output format for animated multi-resource creation. | | `resource_type` | string ("image" | "video") | No | Resource type for multi endpoint. | | `transformation` | string | No | Transformation parameters to apply to the resulting multi-resource (e.g., 'w_200,h_150,c_fill'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Slideshow **Slug:** `CLOUDINARY_CREATE_SLIDESHOW` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | List of tags to assign to the generated slideshow for categorization and search. | | `overwrite` | boolean | No | Whether to overwrite an existing slideshow with the same public_id. Default: false | | `public_id` | string | No | Public ID to assign to the generated slideshow video. If not provided, Cloudinary will auto-generate one. | | `manifest_json` | string | Yes | 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"}]}}' | | `upload_preset` | string | No | Name of an upload preset to apply to the slideshow. Upload presets define default upload options. | | `transformation` | array | No | List of transformation strings to apply to the generated slideshow video. | | `notification_url` | string | No | URL to receive a POST notification when the slideshow creation is complete. Useful for async processing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Streaming Profile **Slug:** `CLOUDINARY_CREATE_STREAMING_PROFILE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the streaming profile. Must be unique within your Cloudinary account. | | `display_name` | string | No | The display name of the streaming profile for easier identification. | | `representations` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Transformation **Slug:** `CLOUDINARY_CREATE_TRANSFORMATION` Tool to create a new named transformation by assigning a custom name to a set of transformation parameters. Use when you need to save and reuse a transformation configuration with a memorable name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the transformation to create. This is the custom name that will be assigned to the transformation set. | | `transformation` | string | Yes | A valid transformation string defining the set of transformations to apply (e.g., 'w_100,h_150,c_fill,g_auto'). | | `allowed_for_strict` | boolean | No | Whether to allow this named transformation when strict transformations are enabled. Strict transformations prevent transformations from being dynamically applied to media assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Trigger **Slug:** `CLOUDINARY_CREATE_TRIGGER` Tool to create a new webhook trigger for a specified event type. Use after configuring your webhook endpoint and choosing the event type. Example: "Create a trigger for uploads to https://example.com/hooks/cloudinary" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uri` | string | Yes | HTTPS URL to receive webhook notifications. | | `event_type` | 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") | Yes | The event type that triggers the webhook notification. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Upload Mapping **Slug:** `CLOUDINARY_CREATE_UPLOAD_MAPPING` Tool to create a new upload mapping folder and URL template. Use when you need to dynamically map external URL prefixes to a Cloudinary asset folder before uploading files. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | The name of the folder to map. | | `template` | string | Yes | The URL prefix to be mapped to the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Upload Preset **Slug:** `CLOUDINARY_CREATE_UPLOAD_PRESET` Tool to create a new upload preset. Use when defining centralized upload options (tags, formats, transformations, etc.) before asset uploads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string | No | OCR add-on to apply. | | `name` | string | No | Name for the new preset. If omitted, Cloudinary generates one. | | `tags` | string | No | Comma-separated list of tags to apply to uploads. | | `eager` | string | No | Eager transformations to generate on upload (e.g., 'c_fill,g_face,h_150,w_150'). | | `proxy` | string | No | Proxy URL for the upload request. | | `folder` | string | No | Folder path in your Cloudinary account to store uploads. | | `context` | string | No | Context metadata in key=value\|key2=value2 format. | | `callback` | string | No | Callback URL to send upload responses. | | `unsigned` | boolean | No | Allow unsigned uploads using this preset. | | `detection` | string | No | Detection add-on to apply (e.g., 'adv_face'). | | `overwrite` | boolean | No | Overwrite any existing asset with the same public_id. Cannot be True when unsigned=True. | | `moderation` | string ("manual" | "webpurify" | "aws_rek" | "aws_rek_video" | "perception_point" | "google_video_moderation" | "duplicate") | No | Type of moderation to apply (if any). | | `auto_tagging` | number | No | Confidence threshold (0.0-1.0) for auto-tagging. | | `use_filename` | boolean | No | Use the original filename of the uploaded asset. | | `resource_type` | string ("image" | "video" | "raw") | No | Asset type this preset applies to. | | `categorization` | string | No | Comma-separated list of categorization add-on(s) to apply. | | `transformation` | string | No | Incoming transformation to apply on upload (e.g., 'c_limit,w_500'). | | `allowed_formats` | string | No | Comma-separated list of allowed formats (e.g., jpg,png). | | `unique_filename` | boolean | No | Append a random suffix to the filename to avoid collisions. | | `notification_url` | string | No | Webhook URL to receive upload notifications. | | `quality_analysis` | boolean | No | Whether to perform quality analysis. | | `background_removal` | string ("cloudinary_ai" | "pixelz") | No | Background removal add-on to apply. | | `cinemagraph_analysis` | boolean | No | Whether to perform cinemagraph analysis. | | `accessibility_analysis` | boolean | No | Whether to perform accessibility analysis. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Asset Relations by Asset ID **Slug:** `CLOUDINARY_DELETE_ASSET_RELATIONS_BY_ASSET_ID` Tool to delete asset relations by asset ID. Use when you need to unrelate a specific asset from other assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | The asset ID of the resource. Must be a 32-character hexadecimal string. | | `assets_to_unrelate` | array | Yes | Unrelates the asset from all the assets specified in this array of assets, specified by their asset IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Asset Relations by Public ID **Slug:** `CLOUDINARY_DELETE_ASSET_RELATIONS_BY_PUBLIC_ID` Tool to delete asset relations by public ID. Use when you need to unrelate assets from a specific asset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The delivery type of the asset (e.g., 'upload', 'private', 'authenticated'). | | `public_id` | string | Yes | The public ID of the asset. | | `resource_type` | string ("image" | "video" | "raw") | Yes | The type of resource. | | `assets_to_unrelate` | array | Yes | Unrelates the asset from all the assets specified in this array, specified as resource_type/type/public_id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Derived Resources **Slug:** `CLOUDINARY_DELETE_DERIVED_RESOURCES` Tool to delete derived assets. Use when you need to remove specific derived assets by their IDs. Example: "Delete derived assets with IDs [id1, id2]". #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `derived_resource_ids` | array | Yes | Array of up to 100 derived resource IDs to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Metadata Field Datasource Entries **Slug:** `CLOUDINARY_DELETE_ENTRIES_IN_METADATA_FIELD_DATASOURCE` Tool to delete datasource entries for a specified metadata field. Use when you need to soft-delete (inactivate) specific entries in a field's datasource. Example prompt: "Delete entries ['color1','color2'] from metadata field 'color_id'" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | External ID of the metadata field whose datasource entries will be deleted. | | `external_ids` | array | Yes | List of datasource entry external IDs to delete (inactivate). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Folder **Slug:** `CLOUDINARY_DELETE_FOLDER` Tool to delete an empty asset folder. Use when the folder is confirmed empty and you need to remove it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | Full path of the empty folder to delete (e.g., 'product/test'). | | `skip_backup` | boolean | No | Whether to delete the folder even if it contains backed up assets. Default: false. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Live Stream **Slug:** `CLOUDINARY_DELETE_LIVE_STREAM` Tool to delete a live stream from Cloudinary. Use when you need to permanently remove a live stream that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | The unique identifier of the live stream to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Live Stream Output **Slug:** `CLOUDINARY_DELETE_LIVE_STREAM_OUTPUT` Tool to delete a live stream output from Cloudinary. Use when you need to remove a specific output configuration from a live stream. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `output_id` | string | Yes | The unique identifier of the live stream output to delete. | | `live_stream_id` | string | Yes | The unique identifier of the live stream. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Metadata Field **Slug:** `CLOUDINARY_DELETE_METADATA_FIELD` Tool to delete a metadata field by external ID. Use when you need to remove a metadata field that is no longer required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | External ID of the metadata field to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Metadata Rule **Slug:** `CLOUDINARY_DELETE_METADATA_RULE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | The unique identifier of the metadata rule to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resources by Asset ID **Slug:** `CLOUDINARY_DELETE_RESOURCES_BY_ASSET_ID` Tool to delete resources by asset IDs. Use when you need to permanently remove specific resources by their immutable asset IDs; irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_ids` | array | Yes | Array of up to 100 immutable Cloudinary asset IDs to delete. | | `invalidate` | boolean | No | Whether to also invalidate CDN cache for deleted assets. | | `keep_original` | boolean | No | If true, only delete derived resources, keeping the original assets. | | `transformations` | array | No | List of transformation strings; only delete derived resources matching these transformations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resources by Public ID **Slug:** `CLOUDINARY_DELETE_RESOURCES_BY_PUBLIC_ID` Tool to delete Cloudinary resources by public ID, prefix, or all resources. Use when you need to permanently remove specific assets by their public IDs, or bulk delete by prefix pattern. Deletion is irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `all` | boolean | No | Delete all assets of the specified resource_type and type (up to 1000 original resources). Mutually exclusive with 'public_ids' and 'prefix'. | | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "list" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | No | Extended storage type of the resource. | | `prefix` | string | No | Delete all assets where the public ID starts with this prefix (up to 1000 original resources). Mutually exclusive with 'public_ids' and 'all'. | | `invalidate` | boolean | No | Whether to invalidate the copies of the resource on the CDN. Takes a few seconds to a few minutes to fully propagate. | | `public_ids` | array | No | 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'. | | `next_cursor` | string | No | 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'. | | `keep_original` | boolean | No | Whether to delete only the derived assets, keeping original assets. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to delete. Use 'video' for both video and audio assets. | | `transformations` | string | No | Only delete derived assets matching this hash of transformation parameters. Multiple transformations can be separated by pipe character (\|). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resources by Tags **Slug:** `CLOUDINARY_DELETE_RESOURCES_BY_TAGS` Tool to delete Cloudinary assets by tag. Use when you need to remove all assets associated with a given tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | Yes | Name of the tag whose resources should be deleted. | | `invalidate` | boolean | No | If true, invalidate CDN cached copies of deleted resources. | | `next_cursor` | string | No | Cursor for pagination when deleting more than 1000 resources. | | `keep_original` | boolean | No | If true, delete only derived assets and keep originals. | | `resource_type` | string ("image" | "raw" | "video") | No | Type of asset to delete. Use 'video' for both video and audio assets. | | `transformations` | string | No | Comma-separated transformation hashes to delete matching derived resources. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Streaming Profile **Slug:** `CLOUDINARY_DELETE_STREAMING_PROFILE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the streaming profile to delete or revert | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Transformation (v2) **Slug:** `CLOUDINARY_DELETE_TRANSFORMATION2` Tool to delete a named transformation from your Cloudinary account. Use when you need to remove a transformation that is no longer required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invalidate` | boolean | No | Invalidate derived resources generated using the deleted transformation from CDN. Set to true to clear cached versions. | | `transformation` | string | Yes | The transformation identifier. Can be either a named transformation (e.g., 'small_profile_thumbnail') or a transformation string (e.g., 'w_100,h_150,c_fill,g_auto'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Trigger **Slug:** `CLOUDINARY_DELETE_TRIGGER` Tool to delete a trigger (webhook notification). Use when you need to remove a trigger by its ID after confirming the correct ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trigger_id` | string | Yes | The unique identifier of the trigger (webhook) to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Upload Mapping **Slug:** `CLOUDINARY_DELETE_UPLOAD_MAPPING` Tool to delete a folder upload mapping. Use when you need to remove an existing upload mapping configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | The folder name of the mapping to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Upload Preset **Slug:** `CLOUDINARY_DELETE_UPLOAD_PRESET` Tool to delete an upload preset from the account. Use when you need to remove an upload preset that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the upload preset to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Destroy Asset **Slug:** `CLOUDINARY_DESTROY_ASSET` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `public_id` | string | Yes | The public ID of the asset to destroy. This operation is permanent and cannot be undone. | | `invalidate` | boolean | No | Whether to invalidate CDN cached copies of the asset. Takes a few seconds to a few minutes to fully propagate through the CDN. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to destroy. Use 'video' for both video and audio assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Destroy Asset by ID **Slug:** `CLOUDINARY_DESTROY_ASSET_BY_ID` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | The immutable asset ID of the resource to delete. | | `callback` | string | No | Callback URL to be notified when the deletion completes. | | `invalidate` | boolean | No | If true, invalidates the CDN cache for the deleted asset (takes up to 1 hour). | | `notification_url` | string | No | Webhook URL to notify when the deletion operation completes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Explicit Resource Update **Slug:** `CLOUDINARY_EXPLICIT_RESOURCE` Tool to update an existing asset and/or eagerly generate derived transformations using Cloudinary's Explicit API. Use when you need to pre-generate transformations, update metadata, move assets to new folders, or modify tags on already-uploaded resources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | List of tags to assign to the resource. Replaces existing tags. | | `type` | string ("upload" | "private" | "authenticated") | No | Delivery type of the resource: upload, private, or authenticated. Defaults to upload. | | `eager` | array | No | 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'). | | `faces` | boolean | No | If true, detect faces in the image and return face coordinates. | | `colors` | boolean | No | If true, extract predominant colors and color histogram. | | `context` | object | No | Custom contextual metadata as key-value pairs (e.g., {'alt': 'Mountain view', 'caption': 'Sunset'}). | | `metadata` | object | No | Structured metadata fields to set on the resource. Keys are metadata field external IDs. | | `overwrite` | boolean | No | If true, overwrite existing derived resources with the same transformation. | | `public_id` | string | Yes | Public ID of the existing resource to update or generate transformations for. | | `invalidate` | boolean | No | If true, invalidates the CDN cache for this asset (takes up to 1 hour). | | `moderation` | string | No | Moderation kind to apply (e.g., 'aws_rek', 'webpurify', 'manual'). | | `eager_async` | boolean | No | If true, eager transformations are generated asynchronously in the background. If false (default), they are generated synchronously. | | `asset_folder` | string | No | New asset folder path to move the resource to (dynamic folder mode). | | `display_name` | string | No | New display name for the asset. | | `resource_type` | string ("image" | "video" | "raw") | No | Resource type: image, video, or raw. Defaults to image. | | `notification_url` | string | No | Webhook URL to notify when eager transformations complete (used with eager_async=true). | | `quality_analysis` | boolean | No | If true, perform image quality analysis. | | `accessibility_analysis` | boolean | No | If true, perform accessibility analysis. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Explode Multi-Page Resource **Slug:** `CLOUDINARY_EXPLODE_RESOURCE` Tool to create derived images from multi-page files (PDF, PSD, TIFF, animated GIF) by exploding them into separate images. Use when you need to extract individual pages or frames from a multi-page resource. The operation is asynchronous and returns a batch_id for tracking. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Delivery type of the resource (e.g., 'upload', 'private', 'authenticated'). Defaults to 'upload' if not specified. | | `format` | string | No | Output format for the derived images (e.g., 'jpg', 'png', 'webp'). If not specified, uses the original format or a default format. | | `public_id` | string | Yes | Public ID of the multi-page resource to explode into separate derived images (e.g., PDF, PSD, TIFF, animated GIF). | | `resource_type` | string ("image") | No | Type of resource to explode. Currently only 'image' is supported for multi-page files (PDF, PSD, TIFF, etc.). | | `transformation` | string | Yes | 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'. | | `notification_url` | string | No | Webhook URL to notify when the asynchronous explode operation completes. The notification includes details about the generated derived images. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Archive **Slug:** `CLOUDINARY_GENERATE_ARCHIVE` Tool to create an archive (ZIP or TGZ file) containing a set of assets from your Cloudinary environment. Use when you need to download multiple assets as a single archive file. Supports filtering by tags, public IDs, or prefixes. The archive is created asynchronously if async=true; use notification_url to receive completion notifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string | No | Mode for archive creation. Use 'create' to always create a new archive or 'download' to return an existing archive if available. | | `tags` | array | No | List of tags to filter assets for inclusion in the archive. Only assets with these tags will be included. | | `type` | string | No | Storage type of the assets to include (e.g., 'upload', 'private', 'authenticated'). | | `async` | boolean | No | Whether to generate the archive asynchronously. If true, the API returns immediately with archive details; the archive is created in the background. Default: false | | `prefixes` | array | No | List of prefixes to filter assets. Only assets with public IDs starting with these prefixes will be included. | | `expires_at` | integer | No | Unix timestamp indicating when the archive should expire and be automatically deleted. | | `public_ids` | array | No | List of public IDs of specific assets to include in the archive. Use when you want to create an archive of specific assets. | | `target_tags` | array | No | List of tags to assign to the generated archive file for categorization and search. | | `keep_derived` | boolean | No | Whether to include derived versions of assets in the archive. Default: false | | `allow_missing` | boolean | No | Whether to allow the archive to be created even if some requested assets are missing. Default: false | | `resource_type` | string ("image" | "video" | "raw" | "all") | Yes | 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. | | `target_format` | string ("zip" | "tgz") | No | Archive file format. | | `flatten_folders` | boolean | No | Whether to flatten the folder structure in the archive. If true, all assets are placed in the root of the archive. Default: false | | `transformations` | string | No | Transformation string to apply to assets before including them in the archive. | | `notification_url` | string | No | URL to receive a POST notification when the archive creation is complete. Useful for async processing. | | `target_public_id` | string | No | Public ID to assign to the generated archive file. If not provided, Cloudinary will auto-generate one. | | `target_asset_folder` | string | No | Asset folder path where the generated archive file should be stored. | | `use_original_filename` | boolean | No | Whether to use the original filename for assets in the archive instead of the public ID. Default: false | | `flatten_transformations` | boolean | No | Whether to flatten the transformations directory structure in the archive. Default: false | | `skip_transformation_name` | boolean | No | Whether to skip including the transformation name in the archived asset filenames. Default: false | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Sprite **Slug:** `CLOUDINARY_GENERATE_SPRITE` Tool to generate sprites by merging multiple images into a single large image. Use when you need to combine multiple images for efficient web delivery. Note: This API was deprecated in 2025 and may not be available in all Cloudinary accounts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | No | Tag identifying the images to include in the sprite. Either 'tag' or 'urls' must be provided, but not both. | | `urls` | array | No | List of URLs of images to include in the sprite. Either 'urls' or 'tag' must be provided, but not both. | | `async` | boolean | No | Set to true for asynchronous sprite generation. Useful for large numbers of images. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resources to include in the sprite. Defaults to 'image'. | | `transformation` | string | No | Transformation string to apply to each image before merging into the sprite. | | `notification_url` | string | No | Webhook URL to notify when async sprite generation completes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Adaptive Streaming Profiles **Slug:** `CLOUDINARY_GET_ADAPTIVE_STREAMING_PROFILES` Tool to list adaptive streaming profiles. Use when retrieving built-in and custom adaptive streaming profiles for delivering video via HLS or DASH. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analysis Task Status **Slug:** `CLOUDINARY_GET_ANALYSIS_TASK_STATUS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `task_id` | string | Yes | The ID of the analysis task to check status for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get product environment config details **Slug:** `CLOUDINARY_GET_CONFIG` Tool to get product environment config details. Use when you need to fetch or verify environment configuration such as folder_mode. Config values like folder_mode constrain uploads, folder creation, and preset creation — check this config before those operations to avoid mode conflicts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `settings` | boolean | No | Whether to include the current configuration settings in the response (e.g., folder_mode). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Live Stream **Slug:** `CLOUDINARY_GET_LIVE_STREAM` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | The unique identifier of the live stream to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Live Stream Output **Slug:** `CLOUDINARY_GET_LIVE_STREAM_OUTPUT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | The unique identifier of the live stream | | `live_stream_output_id` | string | Yes | The unique identifier of the live stream output | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Live Stream Outputs **Slug:** `CLOUDINARY_GET_LIVE_STREAM_OUTPUTS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | Unique identifier of the live stream to retrieve outputs for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Live Streams **Slug:** `CLOUDINARY_GET_LIVE_STREAMS` Tool to get a list of live streams from Cloudinary. Use when you need to retrieve all configured live streams for your account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Metadata Field By ID **Slug:** `CLOUDINARY_GET_METADATA_FIELD_BY_ID` Tool to get a single metadata field definition by external ID. Use after creating or updating a metadata field to fetch its full definition. Example: "Get metadata field definition for external ID 'color_id'." #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | External ID of the metadata field to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource by Asset ID **Slug:** `CLOUDINARY_GET_RESOURCE_BY_ASSET_ID` Get Resource by Asset ID #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `faces` | boolean | No | Include detected face coordinates | | `pages` | boolean | No | Include page count for multi-page documents | | `phash` | boolean | No | Include perceptual hash for similarity detection | | `colors` | boolean | No | Include color histogram and predominant colors | | `asset_id` | string | Yes | Unique immutable asset ID Distinct from public_id; do not substitute public_id here. | | `versions` | boolean | No | Include backed-up version details | | `coordinates` | boolean | No | Include custom crop and face coordinates | | `max_results` | integer | No | Max derived assets to return (1-500) | | `image_metadata` | boolean | No | Include IPTC, XMP, Exif metadata (returns ETag) | | `quality_analysis` | boolean | No | Include image quality analysis scores | | `derived_next_cursor` | string | No | 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. | | `accessibility_analysis` | boolean | No | Include accessibility analysis scores | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource by Public ID **Slug:** `CLOUDINARY_GET_RESOURCE_BY_PUBLIC_ID` Tool to get details of a single resource by public ID. All three of resource_type, type, and public_id must exactly match the stored asset's values; a mismatch in any one causes lookup failure even if the asset exists under a different combination. Returns full asset, derived, and related info. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion" | "list") | Yes | Delivery type: upload, private, etc. | | `faces` | boolean | No | Include detected face coordinates | | `pages` | boolean | No | Include page count for multi-page files | | `phash` | boolean | No | Include perceptual hash for similarity detection | | `colors` | boolean | No | Include color histogram and predominant colors | | `related` | boolean | No | Include list of related assets | | `versions` | boolean | No | Include backed-up versions of the resource | | `public_id` | string | Yes | Public ID of the resource | | `coordinates` | boolean | No | Include custom cropping and face coordinates | | `max_results` | integer | No | 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. | | `resource_type` | string ("image" | "video" | "raw") | Yes | Resource type: image, video, or raw | | `media_metadata` | boolean | No | Include IPTC, XMP, and detailed metadata (returns ETag) | | `quality_analysis` | boolean | No | Include image quality analysis scores | | `derived_next_cursor` | string | No | Cursor for next page of derived assets | | `related_next_cursor` | string | No | Cursor for next page of related assets | | `accessibility_analysis` | boolean | No | Include accessibility analysis scores | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resources by Asset Folder **Slug:** `CLOUDINARY_GET_RESOURCES_BY_ASSET_FOLDER` Tool to list assets stored directly in a specified folder. Use when you need to view assets in a specific folder without including subfolder contents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `max_results` | integer | No | Maximum number of assets to return (1-500). Defaults to 50. | | `next_cursor` | string | No | Cursor for pagination; include to fetch the next page of results. | | `asset_folder` | string | Yes | Name of the asset folder (case-insensitive) to list assets from. An incorrect or misspelled path returns an empty result, not an error. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resources by Context **Slug:** `CLOUDINARY_GET_RESOURCES_BY_CONTEXT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | 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. | | `tags` | boolean | No | Include tag list for each asset. | | `value` | string | No | Contextual metadata value to filter assets. If omitted, returns all assets with the given key. | | `fields` | string | No | Comma-separated list of resource fields to include in each asset. | | `context` | boolean | No | Include contextual metadata key/value pairs for each asset. | | `metadata` | boolean | No | Include structured metadata fields for each asset. | | `direction` | string ("desc" | "-1" | "asc" | "1") | No | Order by created_at date. 'desc' or '-1' (default) for newest first, 'asc' or '1' for oldest first. | | `max_results` | integer | No | Maximum number of assets to return (1-500). Defaults to 10. | | `moderations` | boolean | No | Include image moderation status for each asset. | | `next_cursor` | string | No | Cursor for pagination; include to fetch the next page of results. | | `resource_type` | string ("image" | "raw" | "video") | No | Type of asset to list. Defaults to 'image'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resources in Moderation **Slug:** `CLOUDINARY_GET_RESOURCES_IN_MODERATION` Tool to retrieve assets in a moderation queue by status. Use after moderation to process pending or reviewed assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | boolean | No | Include tags in the response. | | `fields` | string | No | Comma-separated list of fields to include in the response. | | `status` | string ("pending" | "approved" | "rejected" | "queued" | "aborted") | Yes | Moderation status to filter by. | | `context` | boolean | No | Include contextual metadata in the response. | | `metadata` | boolean | No | Include structured metadata in the response. | | `direction` | string ("asc" | "desc" | "1" | "-1") | No | Sort direction of returned results. | | `max_results` | integer | No | Maximum number of results to return (1-500). | | `moderations` | boolean | No | Include asset moderation info in the response. | | `next_cursor` | string | No | Cursor for pagination to fetch the next page. | | `resource_type` | string ("image" | "raw" | "video") | No | Type of resource to query; use 'video' for all videos and audio. | | `moderation_kind` | string ("manual" | "webpurify" | "aws_rek" | "aws_rek_video" | "perception_point" | "google_video_moderation" | "duplicate") | Yes | Moderation list type to query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Root Folders **Slug:** `CLOUDINARY_GET_ROOT_FOLDERS` Tool to list all root folders in the product environment. Use when you need to retrieve top-level asset folders. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Streaming Profile Details **Slug:** `CLOUDINARY_GET_STREAMING_PROFILE_DETAILS` Tool to get details of a single streaming profile by name. Use when you need to inspect an existing profile's configuration before making changes. Example: "Get details of streaming profile 'hd'." #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the streaming profile to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Tags **Slug:** `CLOUDINARY_GET_TAGS` Tool to list all tags used for a specified resource type. Use when you need to retrieve or page through the tags assigned to your assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `prefix` | string | No | Only return tags that start with this prefix. | | `max_results` | integer | No | Max number of tags to return (1-500). Default: 10. | | `next_cursor` | string | No | Opaque cursor for pagination. Pass from prior response to get next page. | | `resource_type` | string ("image" | "video" | "raw") | No | The resource type to list tags for. 'image' (default), 'video' (for both video/audo), or 'raw'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Transformation **Slug:** `CLOUDINARY_GET_TRANSFORMATION` Tool to retrieve details of a specific transformation. Use when you need to get information about a named transformation or transformation string, including its parameters, derived resources, and usage status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `transformation` | string | Yes | The transformation identifier. Can be either a named transformation (e.g., 'small_profile_thumbnail') or a transformation string (e.g., 'w_100,h_150,c_fill,g_auto'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Transformations **Slug:** `CLOUDINARY_GET_TRANSFORMATIONS` Tool to list all transformations (named and unnamed). Use when you need to retrieve transformation definitions or paginate through transformation records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `max_results` | integer | No | Maximum number of transformations to return (1-500). Defaults to 10. | | `next_cursor` | string | No | Cursor for pagination to retrieve the next set of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Triggers **Slug:** `CLOUDINARY_GET_TRIGGERS` Tool to list all webhook triggers for event types in your environment. Use when you need to retrieve or filter existing triggers by type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_type` | string | No | Filter triggers by a specific event type (e.g., 'upload') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Upload Mapping Details **Slug:** `CLOUDINARY_GET_UPLOAD_MAPPING_DETAILS` Tool to retrieve details of a single upload mapping by folder. Use when you need the URL prefix template associated with a specific mapping folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | Name of the upload mapping folder to retrieve details for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Upload Mappings **Slug:** `CLOUDINARY_GET_UPLOAD_MAPPINGS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `max_results` | integer | No | Maximum number of mappings to return (1-500). If omitted, the server default is applied. | | `next_cursor` | string | No | Cursor for paginating through results; omit or unset to start at the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Upload Preset **Slug:** `CLOUDINARY_GET_UPLOAD_PRESET` Tool to retrieve details of a single upload preset by name. Use when you need to inspect an existing preset's configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the upload preset to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Usage **Slug:** `CLOUDINARY_GET_USAGE` Tool to get product environment usage details. Use when you need to monitor your Cloudinary account storage, bandwidth, requests, and other usage limits. Exceeding these limits can silently block uploads and other operations; check usage when operations fail unexpectedly to rule out cap exhaustion. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Video Views **Slug:** `CLOUDINARY_GET_VIDEO_VIEWS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort_by` | string ("view_ended_at" | "video_duration" | "view_watch_time" | "-view_ended_at" | "-video_duration" | "-view_watch_time") | No | Sort order options for video views. | | `expression` | string | No | A set of conditions used to limit the results to rows that match those conditions. For example: `video_public_id=skate` | | `max_results` | integer | No | The maximum number of results to return. Default is 10. | | `next_cursor` | string | No | The cursor for pagination. Use the next_cursor value from a previous response to get the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Idle Live Stream **Slug:** `CLOUDINARY_IDLE_LIVE_STREAM` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `live_stream_id` | string | Yes | The unique identifier of the live stream to idle. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Images **Slug:** `CLOUDINARY_LIST_IMAGES` Tool to list image assets from Cloudinary. Use when you need to retrieve a list of image resources, with optional filtering by prefix, tags, or public IDs. Supports pagination for large result sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default: false | | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "list") | No | Storage type for assets. | | `fields` | array | No | List of fields to include in the response. Note: public_id and asset_id are always included. | | `prefix` | string | No | Find resources with a public ID prefix. Requires the `type` parameter to be set. | | `start_at` | string | No | Retrieve resources uploaded after this timestamp (ISO8601 format). | | `direction` | string ("asc" | "desc") | No | Sort direction for results. | | `public_ids` | array | No | List of public IDs to return. Use to fetch specific images. | | `max_results` | integer | No | Maximum number of results to return (1-500). | | `next_cursor` | string | No | Cursor for pagination. Include this to fetch the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Metadata Fields **Slug:** `CLOUDINARY_LIST_METADATA_FIELDS` Tool to list all structured metadata fields defined in your Cloudinary product environment. Use to retrieve metadata schema definitions, optionally filtered by external IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_ids` | array | No | The external IDs of the metadata fields to retrieve. If not provided, all metadata fields will be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Metadata Rules **Slug:** `CLOUDINARY_LIST_METADATA_RULES` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Raw Files **Slug:** `CLOUDINARY_LIST_RAW_FILES` Tool to list raw assets from Cloudinary. Use when you need to retrieve raw files with optional filtering by prefix, tags, or public IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default: false | | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "list") | No | Storage type of the assets. | | `fields` | array | No | A comma-separated list of fields to include in the response. The following fields are always included: public_id, and asset_id. | | `prefix` | string | No | A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified. | | `start_at` | string | No | An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed. | | `direction` | string ("asc" | "desc") | No | Sort direction for results. | | `public_ids` | array | No | An array of public IDs to return. | | `max_results` | integer | No | Maximum number of results to return (1-500). | | `next_cursor` | string | No | Cursor for pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resources by Asset IDs **Slug:** `CLOUDINARY_LIST_RESOURCES_BY_ASSET_IDS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Optional comma-separated list of fields to include in the response. Fields public_id and asset_id are always included. | | `asset_ids` | array | Yes | List of asset IDs to retrieve. Maximum 100 asset IDs allowed. | | `resource_type` | string ("image" | "video" | "raw") | No | Resource type for filtering results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resources by External IDs **Slug:** `CLOUDINARY_LIST_RESOURCES_BY_EXTERNAL_IDS` Tool to retrieve resources by their external IDs. Use when you need to fetch multiple resources using external identifiers assigned during upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. | | `fields` | string | No | 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. | | `context` | boolean | No | Whether to include key-value pairs of contextual metadata associated with each asset. | | `metadata` | boolean | No | Whether to include structured metadata fields and values assigned to each asset. | | `moderations` | boolean | No | Whether to include image moderation status of each asset. | | `external_ids` | array | Yes | List of external IDs for identifying the assets to retrieve. | | `resource_type` | string ("image" | "video" | "raw") | No | Resource type for filtering. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resources by Tag **Slug:** `CLOUDINARY_LIST_RESOURCES_BY_TAG` Tool to list resources (assets) with a specified tag. Use when you need to retrieve assets filtered by tag value. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | Yes | The tag value to filter resources by (required). | | `direction` | string ("asc" | "desc" | "1" | "-1") | No | Sort order by creation date. 'desc' or '-1' for newest first, 'asc' or '1' for oldest first. | | `max_results` | integer | No | Maximum number of resources to return (1-500). Defaults to 10. | | `next_cursor` | string | No | Cursor for pagination; include to fetch the next page of results. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resources to list. Defaults to 'image'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resources by Type **Slug:** `CLOUDINARY_LIST_RESOURCES_BY_TYPE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated" | "facebook" | "twitter" | "gplus" | "instagram_name" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | No | The storage/delivery type: upload, private, authenticated, facebook, etc. | | `max_results` | integer | No | Max number of resources to return (default: 10, max: 500). | | `next_cursor` | string | No | Cursor value for pagination when more results exist. | | `resource_type` | string ("image" | "video" | "raw") | No | The type of resource: image, video, or raw. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resource Types **Slug:** `CLOUDINARY_LIST_RESOURCE_TYPES` Tool to list all available resource types in your Cloudinary product environment. Use when you need to discover which resource types are available. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Upload Presets **Slug:** `CLOUDINARY_LIST_UPLOAD_PRESETS` Tool to list all upload presets configured in the account. Use when you need to retrieve and paginate through upload preset configurations. For creating a new upload preset, use CLOUDINARY_CREATE_UPLOAD_PRESET. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_by` | string ("name" | "id" | "updated_at") | No | Order by field for upload presets. | | `direction` | string ("asc" | "desc") | No | Sort direction for upload presets. | | `next_cursor` | string | No | Cursor for pagination. Use the next_cursor value from a previous response to get the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Video Assets **Slug:** `CLOUDINARY_LIST_VIDEOS` Tool to list video assets from Cloudinary. Use when you need to retrieve video assets with optional filtering by prefix, public IDs, tags, or timestamps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default: false | | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "list") | No | The storage type of the video assets. Necessary for prefix filtering. | | `fields` | array | No | 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. | | `prefix` | string | No | A public_id prefix. When specified, all videos with that prefix are returned. When using this, the `type` parameter must also be specified. | | `start_at` | string | No | An ISO-8601 formatted timestamp. When specified, videos created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed. | | `direction` | string ("asc" | "desc") | No | Sort direction. | | `public_ids` | array | No | An array of public IDs to return. | | `max_results` | integer | No | Maximum number of results to return (1-500). | | `next_cursor` | string | No | Cursor for pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Manage Context Metadata **Slug:** `CLOUDINARY_MANAGE_CONTEXT` Tool to add or remove contextual metadata on Cloudinary assets. Use when you need to manage custom context key-value pairs on existing assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated") | No | Storage type of the assets. Defaults to 'upload' if not specified. | | `command` | string ("add" | "remove_all") | Yes | Command to perform: 'add' adds or updates context metadata, 'remove_all' removes all context metadata from the specified assets. | | `context` | object | No | Context metadata as key-value pairs to add to the assets. Required when command is 'add'. Not used when command is 'remove_all'. | | `public_ids` | array | Yes | List of public IDs of the assets to update context metadata on. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to update. Defaults to image. Use 'video' for both video and audio assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Order Metadata Field Datasource **Slug:** `CLOUDINARY_ORDER_METADATA_FIELD_DATASOURCE` Tool to update ordering of a metadata field datasource. Use when you need to reorder enum or set values for a metadata field datasource before updating assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_by` | string | Yes | The criteria for sorting the datasource; currently supports only 'value'. | | `direction` | string ("asc" | "desc") | Yes | The direction for sorting: 'asc' (ascending) or 'desc' (descending). | | `external_id` | string | Yes | The external ID of the metadata field whose datasource will be reordered. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Ping Cloudinary Servers **Slug:** `CLOUDINARY_PING_CLOUDINARY_SERVERS` Tool to ping Cloudinary servers. Use when testing API reachability and authentication. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Publish Resources **Slug:** `CLOUDINARY_PUBLISH_RESOURCES` Tool to publish Cloudinary assets by public IDs, prefix, or tag. Use when you need to make authenticated or private assets publicly accessible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | No | Tag of resources to publish. All resources with this tag will be published. Mutually exclusive with public_ids and prefix. | | `type` | string ("upload" | "private" | "authenticated") | No | Current delivery type of the resources to publish. Defaults to 'upload' if not specified. | | `prefix` | string | No | Prefix of public IDs to publish. All resources with this prefix will be published. Mutually exclusive with public_ids and tag. | | `overwrite` | boolean | No | If true, overwrite existing published resources with the same public ID. | | `invalidate` | boolean | No | If true, invalidate CDN cached copies of the resources (takes up to 1 hour). | | `public_ids` | array | No | List of public IDs of resources to publish. Mutually exclusive with prefix and tag. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to publish. Use 'video' for both video and audio assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rename or Move Resource Public ID **Slug:** `CLOUDINARY_RENAME_RESOURCE` Tool to rename an asset's public ID using Cloudinary's rename endpoint. Use when reorganizing resources by changing public_id without re-uploading. Note: renaming changes URLs; optionally invalidate CDN caches. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | No | Current delivery type of the resource. Defaults to 'upload'. | | `to_type` | string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | No | New delivery type for the resource. If not specified, delivery type remains unchanged. | | `overwrite` | boolean | No | If true, overwrites target public_id if it already exists. If false, returns error when target exists. | | `invalidate` | boolean | No | Whether to invalidate CDN cache for the old URL. Important: renaming changes URLs and may break existing links. | | `to_public_id` | string | Yes | New public ID for the resource. Can include folder path (e.g., 'folder/new_name'). | | `resource_type` | string ("image" | "video" | "raw") | Yes | Resource type: image, video, or raw. | | `from_public_id` | string | Yes | Current public ID of the resource to rename. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reorder Metadata Field **Slug:** `CLOUDINARY_REORDER_METADATA_FIELD` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `position` | integer | Yes | The new position for the metadata field (0-indexed). | | `external_id` | string | Yes | External ID of the metadata field to reorder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reorder Metadata Fields **Slug:** `CLOUDINARY_REORDER_METADATA_FIELDS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_by` | string ("label" | "created_at" | "external_id") | Yes | The field to order metadata fields by: 'label' (display name), 'created_at' (creation timestamp), or 'external_id' (unique identifier). | | `direction` | string ("asc" | "desc") | No | Enum for the sort direction. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Restore Metadata Field Datasource Entries **Slug:** `CLOUDINARY_RESTORE_ENTRIES_IN_METADATA_FIELD_DATASOURCE` Tool to restore previously deleted datasource entries for a metadata field. Use after deleting entries to reactivate soft-deleted datasource entries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | External ID of the metadata field whose datasource entries will be restored. | | `external_ids` | array | Yes | List of datasource entry external IDs to restore (unblock). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Restore Deleted Resources **Slug:** `CLOUDINARY_RESTORE_RESOURCES` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | No | Delivery type of the resources to restore. Defaults to 'upload'. | | `versions` | array | No | List of specific version IDs to restore for the resources. If not specified, restores the latest backed-up version. | | `public_ids` | array | Yes | List of public IDs of the deleted resources to restore. Resources must have backups available. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to restore. Defaults to 'image'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Restore Resources by Asset IDs **Slug:** `CLOUDINARY_RESTORE_RESOURCES_BY_ASSET_IDS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `versions` | array | No | List of version IDs to restore. If specified, must match the number of asset_ids exactly. | | `asset_ids` | array | Yes | List of unique immutable asset IDs of backed up assets to restore. | | `notification_url` | string | No | The URL that will receive notification when restore is complete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Assets **Slug:** `CLOUDINARY_SEARCH_ASSETS` Tool to search and filter assets using powerful query expressions. Use when you need to find specific assets by resource type, tags, metadata, or other attributes with sorting and pagination support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | 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. | | `sort_by` | array | No | 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'}]. | | `aggregate` | array | No | Aggregation parameters for grouping results. Can be used to get counts or ranges for specific fields. | | `expression` | string | No | The search expression. Supports exact match, wildcard match, presence, greater/less than, and range. For example: 'resource_type:image AND tags:kitten'. For details on building expressions, see the Search API documentation. | | `with_field` | array | No | The additional fields to include in the response. Note that the fields parameter takes precedence over this parameter. | | `max_results` | integer | No | The maximum number of results to return. Default - 50. Maximum - 500. | | `next_cursor` | string | No | The cursor value to get the next page of results. Available when a previous search returned more results than max_results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Datasource in Metadata Field **Slug:** `CLOUDINARY_SEARCH_DATASOURCE_IN_METADATA_FIELD` Tool to search datasource values in a metadata field. Use when looking for specific values in enum or set metadata fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `term` | string | No | The term to search for. Can be any substring of the value. | | `payload` | object | No | Metadata payload for rule-based inference. | | `exact_match` | boolean | No | Whether to search for an exact match. Default is false. | | `external_id` | string | Yes | The external ID of the metadata field to search the datasource for. | | `max_results` | integer | No | The maximum number of results to return. Default is 255. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Folders **Slug:** `CLOUDINARY_SEARCH_FOLDERS` Tool to search asset folders with filtering, sorting, and pagination. Use when you need to locate specific folders by name, path, or creation date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort_by` | array | No | 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. | | `expression` | string | No | Lucene-like search expression to filter folders. For example: 'name:sample AND created_at>1w'. | | `max_results` | integer | No | Maximum number of folders to return (1-500). Default is 50. | | `next_cursor` | string | No | Cursor for next page of results, from a prior response's next_cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search All Metadata Field Datasources **Slug:** `CLOUDINARY_SEARCH_METADATA_FIELD_DATASOURCE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `term` | string | No | The term to search for. Can be any substring of the value. | | `max_results` | integer | No | The maximum number of results to return. Default is 100. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Visual Search Assets **Slug:** `CLOUDINARY_SEARCH_VISUAL_ASSETS` Tool to find images in your asset library based on visual similarity or content. Use when searching for visually similar images using an image URL, an existing asset, or a text description. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | No | Text description to search for semantically similar images. | | `image_url` | string | No | URL of an image to use as the search query. Find visually similar images. | | `threshold` | number | No | Similarity threshold for filtering results (0.0-1.0). Higher values return more similar results. | | `max_results` | integer | No | Maximum number of results to return (1-500). Defaults to 50. | | `next_cursor` | string | No | Cursor for pagination; include to fetch the next page of results. | | `image_asset_id` | string | No | Asset ID of an existing Cloudinary image to use as the search query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Show Folder **Slug:** `CLOUDINARY_SHOW_FOLDER` Tool to list sub-folders within a specified folder. Use when you need to explore folder hierarchy or list nested folders. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | The path of the folder to operate on, including any nested folders. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Asset Metadata **Slug:** `CLOUDINARY_UPDATE_ASSET_METADATA` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("upload" | "private" | "authenticated") | No | Storage type of the assets. Defaults to 'upload' if not specified. | | `metadata` | object | Yes | Key-value pairs for metadata fields to set. Keys are metadata field external IDs, values are the metadata values to assign. | | `public_ids` | array | Yes | List of public IDs of the assets to update metadata on. | | `clear_invalid` | boolean | No | If true, remove any invalid metadata keys from the request before processing. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of resource to update. Defaults to image. Use 'video' for both video and audio assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Folder **Slug:** `CLOUDINARY_UPDATE_FOLDER` Tool to rename or move an existing asset folder. Use when you need to change the folder's name or location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | Full path of the existing asset folder to update, e.g., 'product/test'. | | `to_folder` | string | Yes | New full path of the asset folder. Changing only the last component renames, only the path moves, or both. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Live Stream **Slug:** `CLOUDINARY_UPDATE_LIVE_STREAM` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of the live stream. | | `live_stream_id` | string | Yes | The unique identifier of the live stream to update. | | `max_runtime_sec` | integer | No | Maximum runtime in seconds for the live stream. The stream will automatically stop after this duration. Set to null to remove limit. | | `idle_timeout_sec` | integer | No | Number of seconds before the stream is considered idle and automatically stopped. Set to null to remove timeout. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Live Stream Output **Slug:** `CLOUDINARY_UPDATE_LIVE_STREAM_OUTPUT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uri` | string | No | The destination URI for the live stream output (e.g., RTMP endpoint for simulcasting). | | `name` | string | No | Descriptive name for the live stream output. | | `public_id` | string | No | Public identifier for the live stream output archive. | | `stream_key` | string | No | Stream key used for authenticating the live stream output. | | `live_stream_id` | string | Yes | The unique identifier of the live stream. | | `live_stream_output_id` | string | Yes | The unique identifier of the live stream output to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Metadata Field **Slug:** `CLOUDINARY_UPDATE_METADATA_FIELD` Tool to update a metadata field definition by external ID. Use when modifying an existing schema field (e.g., changing label or validation) without redefining all properties. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | New label for the metadata field. | | `mandatory` | boolean | No | Whether the field is mandatory. | | `datasource` | object | No | Predefined list of values for enum or set metadata fields. | | `validation` | object | No | Validation rules for the metadata field. | | `external_id` | string | Yes | External ID of the metadata field to update. | | `restrictions` | object | No | UI restrictions object, e.g., {'readonly_ui': True}. | | `default_value` | string | No | Default value for the field (list for 'set' type). | | `default_disabled` | boolean | No | Whether the field is disabled by default for new assets. | | `allow_dynamic_list_values` | boolean | No | Allow dynamic additions of list values (for 'set' type). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Metadata Field Datasource **Slug:** `CLOUDINARY_UPDATE_METADATA_FIELD_DATASOURCE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `values` | array | Yes | List of datasource values to set for this metadata field (replaces existing values). | | `external_id` | string | Yes | External ID of the metadata field to update the datasource for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Metadata Rule **Slug:** `CLOUDINARY_UPDATE_METADATA_RULE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Descriptive name for the metadata rule. | | `state` | string | No | State of the rule: 'active' or 'inactive'. | | `result` | object | No | Result action to perform when the condition is met. | | `position` | integer | No | Position/order of the rule in the rule execution sequence. | | `condition` | object | No | Condition that determines when the metadata rule should be applied. | | `external_id` | string | Yes | The unique identifier of the metadata rule to update. | | `metadata_field_id` | string | No | The metadata field ID that will be modified when the rule triggers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource by Asset ID **Slug:** `CLOUDINARY_UPDATE_RESOURCE_BY_ASSET_ID` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string ("adv_ocr") | No | Type of OCR to perform on the resource. | | `tags` | string | No | Comma-separated list of tags to assign to the resource. | | `context` | string | No | Pipe-separated list of key-value pairs of contextual metadata. | | `regions` | string | No | Named groups of coordinate pairs representing regions. | | `asset_id` | string | Yes | The asset ID of the resource. Must be a 32-character hexadecimal string. | | `metadata` | string | No | Pipe-separated list of custom metadata fields (by external_id) and their values. | | `detection` | string | No | Type of detection to perform on the resource. | | `raw_convert` | string ("aspose" | "google_speech" | "extract_text") | No | Conversion to apply for raw files. | | `asset_folder` | string | No | Folder where the asset should be placed. | | `auto_tagging` | number | No | Confidence threshold for auto-tagging (0 to 1). | | `display_name` | string | No | Display name of the resource. | | `clear_invalid` | boolean | No | Whether to clear invalid metadata fields. If false, invalid fields are preserved. Default: false | | `visual_search` | boolean | No | Whether to index the resource with visual search. Default: false | | `access_control` | array | No | List of access control rules restricting asset access. | | `categorization` | string ("google_tagging" | "google_video_tagging" | "imagga_tagging" | "aws_rek_tagging") | No | Type of categorization to perform on the resource. | | `face_coordinates` | string | No | Face coordinates as comma-separated values, with multiple faces separated by pipes. | | `quality_override` | string | No | Quality override value that will override any automatic quality transformations. | | `moderation_status` | string ("approved" | "rejected") | No | Moderation status of the resource. | | `background_removal` | string ("cloudinary_ai" | "pixelz") | No | Background removal provider to use for the resource. | | `custom_coordinates` | string | No | Custom coordinates as comma-separated values, with multiple coordinates separated by pipes. | | `unique_display_name` | boolean | No | Whether to ensure the display name is unique across all resources. If false and a duplicate exists, the operation fails. Default: false | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource by Public ID **Slug:** `CLOUDINARY_UPDATE_RESOURCE_BY_PUBLIC_ID` Tool to update asset properties by public ID in Cloudinary. Use when you need to modify tags, metadata, display name, or other asset properties without re-uploading. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string ("adv_ocr") | No | Type of OCR to perform on the resource. | | `tags` | string | No | Comma-separated list of tags to assign to the resource. | | `type` | string ("upload" | "private" | "authenticated" | "fetch" | "list" | "facebook" | "twitter" | "gravatar" | "youtube" | "hulu" | "vimeo" | "animoto" | "worldstarhiphop" | "dailymotion") | Yes | Storage type of the resource. | | `context` | string | No | Pipe-separated list of key-value pairs of contextual metadata. | | `regions` | string | No | Named groups of coordinate pairs representing regions. | | `metadata` | string | No | Pipe-separated list of custom metadata fields (by external_id) and their values. | | `detection` | string | No | Type of detection to perform on the resource. | | `public_id` | string | Yes | Public ID of the asset to update. | | `raw_convert` | string ("aspose" | "google_speech" | "extract_text") | No | Conversion to apply for raw files. | | `asset_folder` | string | No | Folder where the asset should be placed. | | `auto_tagging` | number | No | Confidence threshold for auto-tagging (0 to 1). | | `display_name` | string | No | Display name of the resource. | | `clear_invalid` | boolean | No | Whether to clear invalid metadata fields. If false, invalid fields are preserved. Default: false | | `resource_type` | string ("image" | "video" | "raw") | Yes | Type of resource: image, video, or raw. | | `visual_search` | boolean | No | Whether to index the resource with visual search. Default: false | | `access_control` | array | No | List of access control rules restricting asset access. | | `categorization` | string ("google_tagging" | "google_video_tagging" | "imagga_tagging" | "aws_rek_tagging") | No | Type of categorization to perform. | | `face_coordinates` | string | No | Face coordinates as comma-separated values, with multiple faces separated by pipes. | | `quality_override` | string | No | Quality override value that will override any automatic quality transformations. | | `moderation_status` | string ("approved" | "rejected") | No | Moderation status of the resource. | | `background_removal` | string ("cloudinary_ai" | "pixelz") | No | Background removal provider to use. | | `custom_coordinates` | string | No | Custom coordinates as comma-separated values, with multiple coordinates separated by pipes. | | `unique_display_name` | boolean | No | Whether to ensure the display name is unique. If false and a duplicate exists, the operation fails. Default: false | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource Tags **Slug:** `CLOUDINARY_UPDATE_RESOURCE_TAGS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | No | 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. | | `type` | string ("upload" | "private" | "authenticated") | No | Delivery type of the assets. Defaults to 'upload' if not specified. | | `command` | string ("add" | "remove" | "remove_all" | "replace") | Yes | 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. | | `public_ids` | array | Yes | List of public IDs of the assets to update. Maximum: ensure public_ids * tags <= 1000. | | `resource_type` | string ("image" | "video" | "raw") | No | Type of asset to update tags for. Use 'video' for both video and audio assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Streaming Profile **Slug:** `CLOUDINARY_UPDATE_STREAMING_PROFILE` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the streaming profile to update | | `display_name` | string | No | The display name of the streaming profile for easier identification. | | `representations` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Transformation (v2) **Slug:** `CLOUDINARY_UPDATE_TRANSFORMATION2` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `unsafe_update` | string | No | 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. | | `transformation` | string | Yes | The transformation identifier. Can be either a named transformation (e.g., 'small_profile_thumbnail') or a transformation string (e.g., 'w_100,h_150,c_fill,g_auto'). | | `allowed_for_strict` | boolean | No | Whether to allow this named transformation when strict transformations are enabled. Strict transformations prevent transformations from being dynamically applied to media assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Trigger **Slug:** `CLOUDINARY_UPDATE_TRIGGER` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `new_uri` | string | Yes | The updated URL that will receive the notification response. | | `trigger_id` | string | Yes | The unique identifier of the trigger to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Upload Mapping **Slug:** `CLOUDINARY_UPDATE_UPLOAD_MAPPING` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder` | string | Yes | The folder name of the mapping to update. | | `template` | string | Yes | The new URL template to map to the folder. Must start with http:// or https://. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Upload Preset **Slug:** `CLOUDINARY_UPDATE_UPLOAD_PRESET` Tool to update an existing upload preset's configuration settings. Use when modifying preset options like tags, transformations, or analysis features. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string | No | OCR add-on to apply (e.g., adv_ocr). | | `eval` | string | No | Evaluation script to run during upload. | | `name` | string | Yes | Name of the upload preset to update. | | `tags` | string | No | Comma-separated list of tags to apply to uploads. | | `type` | string | No | Upload type (e.g., upload, private, authenticated). | | `async` | boolean | No | Process the upload asynchronously. | | `eager` | string | No | Eager transformations to generate on upload (e.g., 'c_fill,g_face,h_150,w_150'). | | `faces` | boolean | No | Detect faces in the image. | | `phash` | boolean | No | Calculate perceptual hash for the asset. | | `proxy` | string | No | Proxy URL for the upload request. | | `backup` | boolean | No | Create a backup of the original asset. | | `colors` | boolean | No | Extract color information from the asset. | | `folder` | string | No | Folder path in your Cloudinary account to store uploads. | | `format` | string | No | Target format for the uploaded asset. | | `context` | string | No | Context metadata in key=value\|key2=value2 format. | | `headers` | string | No | Custom HTTP headers for delivery. | | `regions` | string | No | Geographic regions for asset distribution. | | `callback` | string | No | Callback URL to send upload responses. | | `metadata` | string | No | Structured metadata fields. | | `unsigned` | boolean | No | Allow unsigned uploads using this preset. | | `detection` | string | No | Detection add-on to apply (e.g., adv_face). | | `overwrite` | boolean | No | Overwrite any existing asset with the same public_id. | | `public_id` | string | No | Public ID for the uploaded asset. | | `invalidate` | boolean | No | Invalidate CDN cache for the asset. | | `moderation` | string | No | Type of moderation to apply (e.g., manual, webpurify, aws_rek, aws_rek_video). | | `on_success` | string | No | Script or action to execute on successful upload. | | `access_mode` | string | No | Access mode for the uploaded asset (e.g., public, authenticated). | | `eager_async` | boolean | No | Generate eager transformations asynchronously. | | `raw_convert` | string | No | Conversion options for raw files. | | `asset_folder` | string | No | Asset folder path for organizing uploads. | | `auto_tagging` | number | No | Confidence threshold (0.0-1.0) for auto-tagging. | | `display_name` | string | No | Display name for the upload preset. | | `use_filename` | boolean | No | Use the original filename of the uploaded asset. | | `upload_preset` | string | No | Name of another preset to chain with. | | `visual_search` | boolean | No | Enable visual search indexing for the asset. | | `access_control` | array | No | Access control list for the asset. | | `categorization` | string | No | Comma-separated list of categorization add-on(s) to apply. | | `media_metadata` | boolean | No | Extract media metadata from the asset. | | `transformation` | string | No | Incoming transformation to apply on upload (e.g., 'c_limit,w_500'). | | `allowed_formats` | string | No | Comma-separated list of allowed file formats (e.g., jpg,png). | | `auto_chaptering` | boolean | No | Enable automatic video chaptering. | | `unique_filename` | boolean | No | Append a random suffix to the filename to avoid collisions. | | `face_coordinates` | string | No | Face coordinates for face-based cropping. | | `notification_url` | string | No | Webhook URL to receive upload notifications. | | `public_id_prefix` | string | No | Prefix to prepend to the public_id. | | `quality_analysis` | boolean | No | Perform quality analysis on the uploaded asset. | | `filename_override` | string | No | Override filename for the uploaded asset. | | `auto_transcription` | string | No | Automatic transcription settings for video. | | `background_removal` | string | No | Background removal add-on to apply (e.g., cloudinary_ai, pixelz). | | `custom_coordinates` | string | No | Custom coordinates for cropping. | | `disallow_public_id` | boolean | No | Prevent specifying public_id during upload. | | `parameter_whitelist` | array | No | List of allowed parameters for unsigned uploads. | | `return_delete_token` | boolean | No | Return a deletion token in the response. | | `unique_display_name` | boolean | No | Ensure unique display names across assets. | | `cinemagraph_analysis` | boolean | No | Perform cinemagraph analysis on the uploaded asset. | | `accessibility_analysis` | boolean | No | Perform accessibility analysis on the uploaded asset. | | `eager_notification_url` | string | No | Webhook URL for eager transformation notifications. | | `responsive_breakpoints` | array | No | Configuration for responsive image breakpoints. | | `discard_original_filename` | boolean | No | Discard the original filename during upload. | | `use_filename_as_display_name` | boolean | No | Use filename as display name for the asset. | | `use_asset_folder_as_public_id_prefix` | boolean | No | Use asset folder as public_id prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload Asset **Slug:** `CLOUDINARY_UPLOAD_ASSET` Tool to upload media assets (images, videos, raw files) to Cloudinary. Use when you need to upload files from local storage or remote URLs. Supports both synchronous and asynchronous uploads with various transformation and analysis options. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to upload. Either this or file_url must be provided. | | `tags` | string | No | Comma-separated list of tags to assign to the uploaded asset. | | `async` | boolean | No | When true, the upload is processed asynchronously. Returns batch_id and status immediately. | | `eager` | string | No | Comma-separated list of eager transformations to generate during upload. | | `faces` | boolean | No | Whether to detect faces in the image and include face coordinates in the response. | | `phash` | boolean | No | Whether to generate a perceptual hash for similarity detection. | | `colors` | boolean | No | Whether to extract predominant colors from the image. | | `folder` | string | No | Folder path where the asset should be stored (e.g., 'images/events/2023'). | | `format` | string | No | Format to convert the uploaded asset to (e.g., 'jpg', 'png', 'webp'). | | `context` | string | No | Context metadata in pipe-separated format (e.g., 'alt=My Image\|caption=Sunset'). | | `file_url` | string | No | URL of a remote file to upload. Either this or file must be provided. Cloudinary will fetch and upload the file from this URL. | | `overwrite` | boolean | No | Whether to overwrite existing assets with the same public ID. Default is false. | | `public_id` | string | No | Public ID to assign to the uploaded asset. If not specified, Cloudinary generates one automatically. | | `moderation` | string | No | Moderation kind to apply (e.g., 'manual', 'webpurify', 'aws_rek'). | | `auto_tagging` | number | No | Confidence threshold (0.0-1.0) for automatic tagging using AI detection. | | `use_filename` | boolean | No | Whether to use the original filename as the public ID (without extension). Default is false. | | `resource_type` | string ("image" | "video" | "raw" | "auto") | No | 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. | | `upload_preset` | string | No | Name of an upload preset to use. Upload presets define default upload parameters. | | `transformation` | string | No | Transformation to apply on upload (e.g., 'w_400,h_300,c_fill'). | | `unique_filename` | boolean | No | When true and use_filename is also true, adds random characters to ensure uniqueness. Default is true. | | `notification_url` | string | No | Webhook URL to notify when the upload or transformation completes. | | `quality_analysis` | boolean | No | Whether to perform quality analysis on the uploaded image. | | `background_removal` | string | No | Background removal mode (e.g., 'cloudinary_ai'). | | `accessibility_analysis` | boolean | No | Whether to perform accessibility analysis on the uploaded image. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload File Chunk **Slug:** `CLOUDINARY_UPLOAD_CHUNK` Tool to upload a single chunk of a large file to Cloudinary. Use when implementing chunked upload for large files. All chunks of the same file must use the same x_unique_upload_id. The final chunk triggers processing and returns the complete upload response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string | No | OCR configuration for text extraction. | | `eval` | string | No | Evaluation script to run on upload. | | `file` | string | Yes | The file data to upload. Must be base64-encoded with data URI scheme (e.g., 'data:text/plain;base64,VGhpcyBpcyBhIHRlc3Q='). | | `tags` | string | No | Comma-separated tags to assign to the asset. | | `type` | string | No | Delivery type (e.g., 'upload', 'private', 'authenticated'). | | `async` | boolean | No | If true, process the upload asynchronously. | | `eager` | string | No | Eager transformations to apply immediately upon upload. | | `faces` | boolean | No | If true, detect faces in the image. | | `phash` | boolean | No | If true, calculate perceptual hash. | | `proxy` | string | No | Proxy configuration. | | `backup` | boolean | No | If true, create a backup of the asset. | | `colors` | boolean | No | If true, extract predominant colors from the image. | | `folder` | string | No | Folder path where the asset should be stored. | | `format` | string | No | Target format for the uploaded file. | | `context` | string | No | Custom context metadata in pipe-separated key=value format (e.g., 'caption=My photo\|alt=Description'). | | `headers` | string | No | Custom headers to include in the upload. | | `regions` | string | No | Regions for analysis or processing. | | `callback` | string | No | URL for callback on upload completion. | | `metadata` | string | No | Structured metadata in pipe-separated key=value format. | | `detection` | string | No | Detection configuration. | | `overwrite` | boolean | No | If true, overwrite existing asset with the same public ID. | | `public_id` | string | No | Custom public ID for the asset. | | `invalidate` | boolean | No | If true, invalidate CDN cache for this asset. | | `moderation` | string | No | Moderation kind to apply (e.g., 'manual', 'aws_rek'). | | `on_success` | string | No | Script to run on successful upload. | | `access_mode` | string | No | Access mode for the asset (e.g., 'public', 'authenticated'). | | `eager_async` | boolean | No | If true, eager transformations are generated asynchronously. | | `raw_convert` | string | No | Raw conversion configuration. | | `asset_folder` | string | No | The asset folder path where the file should be stored. | | `auto_tagging` | number | No | Confidence threshold for automatic tagging. | | `display_name` | string | No | Display name for the uploaded asset. | | `use_filename` | boolean | No | If true, use the original filename as the public ID. | | `content_range` | string | Yes | 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. | | `resource_type` | string ("image" | "video" | "raw" | "auto") | No | 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. | | `upload_preset` | string | No | Name of an upload preset to use. | | `visual_search` | boolean | No | If true, enable visual search indexing. | | `access_control` | array | No | Access control rules for the asset. | | `categorization` | string | No | Categorization configuration. | | `media_metadata` | boolean | No | If true, extract media metadata. | | `transformation` | string | No | Transformation to apply on upload. | | `allowed_formats` | string | No | Comma-separated list of allowed formats. | | `auto_chaptering` | boolean | No | If true, automatically generate chapters for video content. | | `unique_filename` | boolean | No | If true, ensure the filename is unique. | | `face_coordinates` | string | No | Face coordinates for face-based cropping. | | `notification_url` | string | No | Webhook URL to notify on upload completion. | | `public_id_prefix` | string | No | Prefix to add to the public ID. | | `quality_analysis` | boolean | No | If true, perform image quality analysis. | | `filename_override` | string | No | Override the filename. | | `auto_transcription` | string | No | Configuration for automatic transcription of video/audio content. | | `background_removal` | string | No | Background removal configuration. | | `custom_coordinates` | string | No | Custom coordinates for cropping. | | `x_unique_upload_id` | string | Yes | A unique identifier for the upload. Must be the same for all chunks of the same file. | | `return_delete_token` | boolean | No | If true, return a delete token that can be used to delete the asset. | | `unique_display_name` | boolean | No | If true, ensure the display name is unique. | | `cinemagraph_analysis` | boolean | No | If true, perform cinemagraph analysis. | | `accessibility_analysis` | boolean | No | If true, perform accessibility analysis on the uploaded file. | | `eager_notification_url` | string | No | Webhook URL to notify when eager transformations complete. | | `responsive_breakpoints` | array | No | Configuration for responsive breakpoints generation. | | `discard_original_filename` | boolean | No | If true, discard the original filename. | | `use_filename_as_display_name` | boolean | No | If true, use the filename as the display name. | | `use_asset_folder_as_public_id_prefix` | boolean | No | If true, use the asset folder as the public ID prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload File (Auto Detect) **Slug:** `CLOUDINARY_UPLOAD_FILE_AUTO_DETECT` Tool to upload files with automatic resource type detection. Use when uploading images, videos, or raw files without specifying the type. Cloudinary automatically detects whether the file is an image, video, or raw file based on its content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | string | No | OCR add-on to apply (e.g., 'adv_ocr'). | | `eval` | string | No | Conditional transformation logic to execute. | | `file` | string | Yes | The file to upload. Can be a URL (http/https), a local file path, or base64-encoded data URI (e.g., 'data:image/png;base64,...'). | | `tags` | string | No | Comma-separated list of tags to assign to the uploaded asset. | | `type` | string | No | Delivery type of the asset (e.g., 'upload', 'private', 'authenticated'). | | `async` | boolean | No | Process the upload asynchronously in the background. | | `eager` | string | No | Pipe-separated list of eager transformations to pre-generate (e.g., 'c_fill,w_300,h_200\|c_thumb,w_100,h_100'). | | `faces` | boolean | No | Detect faces in the image and return face coordinates. | | `phash` | boolean | No | Generate perceptual hash for the image. | | `proxy` | string | No | Proxy URL for the upload request when uploading from a URL. | | `backup` | boolean | No | Create a backup copy of the asset. | | `colors` | boolean | No | Extract predominant colors and color histogram. | | `folder` | string | No | Folder path in your Cloudinary account to store the upload. | | `format` | string | No | Convert the uploaded asset to this format. | | `context` | string | No | Context metadata in pipe-separated format: key1=value1\|key2=value2. | | `headers` | string | No | Custom headers to send when uploading from a URL (newline-separated). | | `regions` | string | No | Regional settings for the upload. | | `callback` | string | No | Callback URL to redirect after upload (non-XHR requests). | | `metadata` | string | No | Structured metadata in pipe-separated format: field1=value1\|field2=value2. | | `detection` | string | No | Detection add-on to apply (e.g., 'adv_face', 'captioning'). | | `overwrite` | boolean | No | Overwrite any existing asset with the same public ID. | | `public_id` | string | No | Public ID to assign to the uploaded asset. If not provided, Cloudinary generates one automatically. | | `invalidate` | boolean | No | Invalidate CDN cache for this asset (takes up to 1 hour). | | `moderation` | string | No | Moderation kind to apply (e.g., 'manual', 'aws_rek', 'webpurify'). | | `on_success` | string | No | Cloudinary function to execute on successful upload. | | `access_mode` | string | No | Access mode for the asset (e.g., 'public', 'authenticated'). | | `eager_async` | boolean | No | Generate eager transformations asynchronously. | | `raw_convert` | string | No | Convert raw files using the specified conversion settings. | | `asset_folder` | string | No | Dynamic asset folder path to organize assets (overrides folder if provided). | | `auto_tagging` | number | No | Confidence threshold (0.0-1.0) for automatic tagging. | | `display_name` | string | No | Display name for the asset. | | `use_filename` | boolean | No | Use the original filename of the uploaded file as the public ID. | | `upload_preset` | string | No | Name of an upload preset to use. Upload preset settings override individual parameters. | | `visual_search` | boolean | No | Enable visual search indexing for this asset. | | `access_control` | string | No | Access control rules for the asset in JSON format (e.g., '[{"access_type":"token"}]'). | | `categorization` | string | No | Comma-separated list of categorization add-ons to apply. | | `media_metadata` | boolean | No | Extract embedded media metadata (EXIF, IPTC, XMP). | | `transformation` | string | No | Incoming transformation to apply on upload (e.g., 'c_limit,w_500'). | | `allowed_formats` | string | No | Comma-separated list of allowed formats. Upload will fail if file format is not in this list. | | `auto_chaptering` | boolean | No | Enable automatic chaptering for video files. | | `unique_filename` | boolean | No | Add a random suffix to the filename to avoid collisions. Default is true. | | `face_coordinates` | string | No | Face coordinates for face-based cropping. | | `notification_url` | string | No | Webhook URL to notify when upload completes. | | `public_id_prefix` | string | No | Prefix to prepend to the public ID. | | `quality_analysis` | boolean | No | Perform image quality analysis. | | `filename_override` | string | No | Override the original filename. | | `auto_transcription` | string | No | Auto-transcription settings for video files in JSON format. | | `background_removal` | string | No | Background removal add-on to apply (e.g., 'cloudinary_ai', 'pixelz'). | | `custom_coordinates` | string | No | Custom coordinates for cropping in the format 'x,y,width,height'. | | `return_delete_token` | boolean | No | Return a delete token that can be used to delete the asset within 10 minutes. | | `unique_display_name` | boolean | No | Add a random suffix to the display name to avoid collisions. | | `cinemagraph_analysis` | boolean | No | Perform cinemagraph analysis. | | `accessibility_analysis` | boolean | No | Perform accessibility analysis. | | `eager_notification_url` | string | No | Webhook URL to notify when eager transformations complete. | | `responsive_breakpoints` | string | No | Responsive breakpoints configuration in JSON format for generating responsive image variants. | | `discard_original_filename` | boolean | No | Discard the original filename. | | `use_filename_as_display_name` | boolean | No | Use the original filename as the display name. | | `use_asset_folder_as_public_id_prefix` | boolean | No | Use the asset folder as a prefix for the public ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |