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.
Cloudinary is a cloud-based media management platform for uploading, storing, transforming, and delivering images and videos via CDN.
Tool to manually activate a Cloudinary live stream. Use when you need to start a live stream that is in an inactive state.
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.
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.
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.
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.
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.
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.
Tool to create a new metadata field definition. Use when extending your metadata schema with new fields.
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.
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.
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.
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.
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.
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"
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.
Tool to create a new upload preset. Use when defining centralized upload options (tags, formats, transformations, etc.) before asset uploads.
Tool to delete asset relations by asset ID. Use when you need to unrelate a specific asset from other assets.
Tool to delete asset relations by public ID. Use when you need to unrelate assets from a specific asset.
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]".
Tool to delete an empty asset folder. Use when the folder is confirmed empty and you need to remove it.
Tool to delete a live stream from Cloudinary. Use when you need to permanently remove a live stream that is no longer needed.
Tool to delete a live stream output from Cloudinary. Use when you need to remove a specific output configuration from a live stream.
Tool to delete a metadata field by external ID. Use when you need to remove a metadata field that is no longer required.
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'"
Tool to delete a conditional metadata rule by its ID. Use when you need to remove a metadata rule that is no longer required.
Tool to delete resources by asset IDs. Use when you need to permanently remove specific resources by their immutable asset IDs; irreversible.
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.
Tool to delete Cloudinary assets by tag. Use when you need to remove all assets associated with a given tag.
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.
Tool to delete a named transformation from your Cloudinary account. Use when you need to remove a transformation that is no longer required.
Tool to delete a trigger (webhook notification). Use when you need to remove a trigger by its ID after confirming the correct ID.
Tool to delete a folder upload mapping. Use when you need to remove an existing upload mapping configuration.
Tool to delete an upload preset from the account. Use when you need to remove an upload preset that is no longer needed.
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.
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.
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.
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.
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.
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.
Tool to list adaptive streaming profiles. Use when retrieving built-in and custom adaptive streaming profiles for delivering video via HLS or DASH.
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.
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.
Tool to get details of a single live stream output. Use when you need information about a specific output configuration for a live stream.
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.
Tool to get a list of live streams from Cloudinary. Use when you need to retrieve all configured live streams for your account.
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'."
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.
Get Resource by Asset 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.
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.
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.
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.
Tool to retrieve assets in a moderation queue by status. Use after moderation to process pending or reviewed assets.
Tool to list all root folders in the product environment. Use when you need to retrieve top-level asset folders.
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'."
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.
Tool to list all transformations (named and unnamed). Use when you need to retrieve transformation definitions or paginate through transformation records.
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.
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.
Tool to retrieve details of a single upload preset by name. Use when you need to inspect an existing preset's configuration.
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.
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.
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.
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.
Tool to list all structured metadata fields defined in your Cloudinary product environment. Use to retrieve metadata schema definitions, optionally filtered by external IDs.
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.
Tool to list raw assets from Cloudinary. Use when you need to retrieve raw files with optional filtering by prefix, tags, or public IDs.
Tool to list all available resource types in your Cloudinary product environment. Use when you need to discover which resource types are available.
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.
Tool to retrieve resources by their external IDs. Use when you need to fetch multiple resources using external identifiers assigned during upload.
Tool to list resources (assets) with a specified tag. Use when you need to retrieve assets filtered by tag value.
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.).
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.
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.
Tool to list all webhook triggers for event types in your environment. Use when you need to retrieve or filter existing triggers by type.
Tool to add or remove contextual metadata on Cloudinary assets. Use when you need to manage custom context key-value pairs on existing assets.
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.
Tool to ping Cloudinary servers. Use when testing API reachability and authentication.
Tool to publish Cloudinary assets by public IDs, prefix, or tag. Use when you need to make authenticated or private assets publicly accessible.
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.
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.
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.
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.
Tool to restore previously deleted datasource entries for a metadata field. Use after deleting entries to reactivate soft-deleted datasource entries.
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.
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.
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.
Tool to search datasource values in a metadata field. Use when looking for specific values in enum or set metadata fields.
Tool to search asset folders with filtering, sorting, and pagination. Use when you need to locate specific folders by name, path, or creation date.
Tool to list sub-folders within a specified folder. Use when you need to explore folder hierarchy or list nested folders.
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.
Tool to rename or move an existing asset folder. Use when you need to change the folder's name or location.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
Tool to update an existing upload preset's configuration settings. Use when modifying preset options like tags, transformations, or analysis features.
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.
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.
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.
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.