Skip to content
Changelog

Report a bug

Cloudinary integration: operations for AI agents

Cloudinary connects to Type.com as an integration. This page lists the 203 operations documented for Claude and Codex in Type.com: 77 read, 70 write, 56 destructive.

About Cloudinary

Cloudinary API route references across twelve vendor schemas, subject to Type setup and account access.

Categories: Design & Media

How to connect Cloudinary to Type.com

Connect
Configure provider-specific target and authentication setup.
Access
Organization connection: one shared account for the workspace.
MCP
Selected AI media-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

203 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

203 operations listed.

api

  • Read

    Generates a download link for a specific asset (image)

    Generates a download link for a specific asset (image)

    GET /v1_1/{cloud_name}/{resource_type}/download

  • Read

    Download a backup copy of an asset

    Download a backup copy of an asset

    GET /v1_1/{cloud_name}/download_backup

  • Read

    Download an asset by asset ID

    Generates a download link for a specific asset identified by its immutable asset ID, instead of the resource type, delivery type and public ID.

    GET /v1_1/{cloud_name}/asset/download

  • Read

    Lists all transformation definitions in your account, including named transformations

    Retrieves a list of all transformations, which can be filtered to show either only named or unnamed transformations.

    GET /v1_1/{cloud_name}/transformations

  • Read

    Retrieves details of a specific transformation

    Retrieves details for a named or unnamed transformation.

    GET /v1_1/{cloud_name}/transformations/{transformation}

  • Read

    Lists all upload presets configured in the account

    Lists all upload presets configured in the account

    GET /v1_1/{cloud_name}/upload_presets

  • Read

    Retrieves details of a single upload preset

    Retrieves details of a single upload preset

    GET /v1_1/{cloud_name}/upload_presets/{name}

  • Read

    Lists all structured metadata fields defined in your Cloudinary product environment

    Retrieves a list of all metadata fields in the product environment based on the provided filters.

    GET /v1_1/{cloud_name}/metadata_fields

  • Read

    Retrieves the definition of a specific structured metadata field by its identifier (external_id)

    Retrieves detailed information about the specified metadata field.

    GET /v1_1/{cloud_name}/metadata_fields/{external_id}

  • Read

    Search across all metadata field datasources

    Performs a search across all metadata field datasources to find matching values.

    POST /v1_1/{cloud_name}/metadata_fields/datasource/search

  • Read

    Search datasource values in a metadata field

    Performs a search within a specific metadata field's datasource to find matching values, with support for exact or partial matches.

    POST /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource/search

  • Read

    Retrieves a list of all conditional metadata rules defined in your account

    Retrieves a list of all metadata rules in the cloud.

    GET /v1_1/{cloud_name}/metadata_rules

  • Read

    Retrieves a list of all upload mapping rules configured in your Cloudinary product environment

    Returns a list of all upload mappings defined for your account. Upload mappings allow you to map an upload preset to a specific folder and URL template.

    GET /v1_1/{cloud_name}/upload_mappings

  • Read

    Lists all webhook notification triggers configured for your product environment

    Retrieves a list of all event triggers and notifications within your product environment.

    GET /v1_1/{cloud_name}/triggers

  • Read

    Tests an existing trigger's filter against sample data

    Evaluates an existing trigger's filter against provided sample data. Use this endpoint to verify that a trigger's filter will match expected events.

    POST /v1_1/{cloud_name}/triggers/{id}/test

  • Read

    Get resource types

    Returns a list of all resource types that correspond to assets currently in your product environment.

    GET /v1_1/{cloud_name}/resources

  • Read

    Get image assets

    Retrieves a list of image assets. Results can be filtered by various criteria like tags, prefix, or specific public IDs.

    GET /v1_1/{cloud_name}/resources/image

  • Read

    Get video assets

    Retrieves a list of video assets. Results can be filtered by various criteria like tags, prefix, or specific public IDs.

    GET /v1_1/{cloud_name}/resources/video

  • Read

    Get raw assets

    Retrieves a list of raw assets. Results can be filtered by various criteria like tags, prefix, or specific public IDs.

    GET /v1_1/{cloud_name}/resources/raw

  • Read

    Get resources by asset folder

    Retrieves a list of resources within a specific asset folder. Requires folder decoupling to be enabled.

    GET /v1_1/{cloud_name}/resources/by_asset_folder

  • Read

    Get resources by asset IDs

    Retrieves details for specific resources using their asset IDs (or external IDs).

    GET /v1_1/{cloud_name}/resources/by_asset_ids

  • Read

    Get resources by context

    Retrieves resources matching specific context key/value pairs.

    GET /v1_1/{cloud_name}/resources/{resource_type}/context

  • Read

    Get resources by moderation kind and status

    Retrieves resources matching specific moderation kind and status.

    GET /v1_1/{cloud_name}/resources/{resource_type}/moderations/{moderation_kind}/{moderation_status}

  • Read

    Get resources by external IDs

    Retrieves details for specific resources using their external IDs (or asset IDs).

    GET /v1_1/{cloud_name}/resources/by_external_ids

  • Read

    Get resource by public ID

    Returns the details of a single resource specified by its public ID.

    GET /v1_1/{cloud_name}/resources/{resource_type}/{type}/{public_id}

  • Read

    Get resource by asset ID

    Returns the details of a single resource specified by its asset ID.

    GET /v1_1/{cloud_name}/resources/{asset_id}

  • Read

    Retrieves a list of tags currently applied to assets in your Cloudinary account

    Retrieves a comprehensive list of all tags that exist in your product environment for assets of the specified type. [Cloudinary Admin API documentation](https://cloudinary.com/documentation/admin_api)

    GET /v1_1/{cloud_name}/tags/{resource_type}

  • Read

    Retrieves comprehensive usage metrics and account statistics

    A report on the status of product environment usage, including storage, credits, bandwidth, requests, number of resources, and add-on usage. No date parameter needed to get current usage statistics.

    GET /v1_1/{cloud_name}/usage

  • Read

    Get video views

    Retrieves analytics data for video views. Results can be filtered using expressions based on various criteria such as video public ID, view duration, viewer information, and more.

    GET /v1_1/{cloud_name}/video/analytics/views

  • Read

    Lists all adaptive streaming profiles (both built-in and custom) defined in your Cloudinary account

    Lists all adaptive streaming profiles (both built-in and custom) defined in your Cloudinary account

    GET /v1_1/{cloud_name}/streaming_profiles

  • Read

    Retrieves the details of a single adaptive streaming profile by its name

    Retrieves the details of a single adaptive streaming profile by its name

    GET /v1_1/{cloud_name}/streaming_profiles/{name}

  • Read

    List sub-folders

    Returns a list of sub-folders under the specified folder path.

    GET /v1_1/{cloud_name}/folders/{folder}

  • Read

    Get root folders

    Retrieves an array of all root folders in your Cloudinary product environment. Limited to 2000 results.

    GET /v1_1/{cloud_name}/folders

  • Read

    Searches for folders whose attributes match a given expression

    Lists the folders that match the specified search expression. Limited to 2000 results. If no parameters are passed, returns the 50 most recently created folders in descending order of creation time.

    GET /v1_1/{cloud_name}/folders/search

  • Read

    Get folder roles

    Lists the principals (users, groups, or API keys) and their role assignments on a specific folder, including roles inherited from ancestor folders.

    GET /v1_1/{cloud_name}/folder_operations/invite/{folder_id}

  • Read

    List the assets in a folder by container ID

    Returns the assets contained in the folder identified by the given container ID.

    GET /v1_1/{cloud_name}/resources/by_container_id/{container_id}

  • Read

    List initial backups

    Lists initial backup operations for the active product environment, ordered from most recent to oldest.

    GET /v1_1/{cloud_name}/operations/initial_backup

  • Read

    Get initial backup

    Retrieves the progress and status of a single initial backup operation by its ID.

    GET /v1_1/{cloud_name}/operations/initial_backup/{id}

  • Read

    List recognized people

    Returns a list of all recognized people in your product environment. People Search must be enabled for this product environment.

    GET /v1_1/{cloud_name}/people

  • Read

    Get person details

    Returns details of a specific recognized person. People Search must be enabled for this product environment.

    GET /v1_1/{cloud_name}/people/{person_id}

  • Read

    Inspect the caller's permitted actions on people

    Returns, for each requested person and action, whether the authenticated caller is permitted to perform that action.

    POST /v1_1/{cloud_name}/people/inspect

  • Read

    Check the status and result of a generation task

    Check on an image generation running in the background: whether it is pending, processing, completed or failed, and, once it has completed, the generated images with their URLs, size and format.

    GET /v2/generate/{cloud_name}/tasks/{task_id}

  • Write

    Create derived images from multi-page file

    Generates derived images for each of the individual pages/frames in a multi-page/frame file (such as a PDF or animated image).

    POST /v1_1/{cloud_name}/{resource_type}/explode

  • Write

    Creates an archive (ZIP or TGZ file) that contains a set of assets from your product environment.

    Creates a downloadable ZIP or other archive format containing the specified resources.

    POST /v1_1/{cloud_name}/{resource_type}/generate_archive

  • Write

    Create image from text

    Dynamically generates an image from a specified text string.

    POST /v1_1/{cloud_name}/{resource_type}/text

  • Write

    Creates a new named transformation by assigning a custom name to a set of transformation parameters

    Creates a new named transformation with the given name and transformation string.

    POST /v1_1/{cloud_name}/transformations/{transformation}

  • Write

    Creates a new upload preset with specified configuration settings

    Creates a new upload preset with specified configuration settings

    POST /v1_1/{cloud_name}/upload_presets

  • Write

    Updates an existing upload preset's configuration settings

    Updates an existing upload preset's configuration settings

    PUT /v1_1/{cloud_name}/upload_presets/{name}

  • Write

    Creates a new structured metadata field in your account

    Creates a new metadata field with the specified properties and configuration.

    POST /v1_1/{cloud_name}/metadata_fields

  • Write

    Reorder all metadata fields

    Changes the display order of all metadata fields based on specified criteria.

    PUT /v1_1/{cloud_name}/metadata_fields/order

  • Write

    Change position of metadata field

    Changes the display position of a specific metadata field within the list.

    PUT /v1_1/{cloud_name}/metadata_fields/{external_id}/reorder

  • Write

    Updates the allowed values (the datasource) for a specified metadata field

    Updates the values in a metadata field's datasource, including adding, modifying, or changing the order of values.

    PUT /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource

  • Write

    Order the datasource values of a metadata field

    Reorders the allowed values (the datasource) of a metadata field according to the given field and direction. This is the backward-compatible variant of the order endpoint.

    POST /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource/order

  • Write

    Order the datasource values of a metadata field

    Reorders the allowed values (the datasource) of a metadata field according to the given field and direction.

    PUT /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource/order

  • Write

    Restore datasource values

    Restores datasource values that have been deleted.

    POST /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource_restore

  • Write

    Creates a new upload mapping

    Creates a new upload mapping for the specified folder

    POST /v1_1/{cloud_name}/upload_mappings

  • Write

    Updates an existing upload mapping by changing its remote URL template for a given folder

    Updates the URL template for an existing folder mapping

    PUT /v1_1/{cloud_name}/upload_mappings

  • Write

    Creates a new notification trigger (webhook) by specifying an event type and a destination

    Creates a new trigger. Your product environment supports triggers up to a maximum determined by multiplying the number of unique event types by the limit of 30 notification URLs.

    POST /v1_1/{cloud_name}/triggers

  • Write

    Updates the callback URL of an existing webhook trigger in your Cloudinary account

    Updates a notification URL for a trigger.

    PUT /v1_1/{cloud_name}/triggers/{id}

  • Write

    Restore assets by asset ID

    Restores one or more resources from backup using their asset IDs. Can optionally specify versions to restore.

    POST /v1_1/{cloud_name}/resources/restore

  • Write

    Add related assets by asset ID

    Relates an asset to other assets by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or delivery type. This is a bidirectional process, meaning that the asset will also be added as a related_asset to all the other assets specified. The relation is also a one to many relationship, where the asset is related to all the assets specified, but those assets aren't also related to each other.

    POST /v1_1/{cloud_name}/resources/related_assets/{asset_id}

  • Write

    Create asset relations by public ID

    Relates an asset to other assets by public IDs. This allows you to indicate that the asset is logically related to other assets in some way (e.g., similar content, or a peripheral asset like video/transcript, etc). This is a bidirectional process, meaning that the asset is also added as a related_asset to all the other assets specified. The relation is also a one to many relationship, where the asset is related to all the assets specified, but those assets aren't also related to each other.

    POST /v1_1/{cloud_name}/resources/related_assets/{resource_type}/{type}/{public_id}

  • Write

    Creates a new adaptive streaming profile in your Cloudinary account

    Creates a new adaptive streaming profile in your Cloudinary account

    POST /v1_1/{cloud_name}/streaming_profiles

  • Write

    Modifies an existing adaptive streaming profile's configuration

    Modifies an existing adaptive streaming profile's configuration

    PUT /v1_1/{cloud_name}/streaming_profiles/{name}

  • Write

    Renames or moves an entire folder (along with all assets it contains) to a new location

    Renames or moves an entire folder (along with all assets it contains) to a new location within your Cloudinary media library.

    PUT /v1_1/{cloud_name}/folders/{folder}

  • Write

    Creates a new empty folder in your Cloudinary media library

    Creates a new folder at the specified path

    POST /v1_1/{cloud_name}/folders/{folder}

  • Write

    Searches for folders in your product environment

    Lists the folders that match the specified search expression. Limited to 2000 results. If no parameters are passed, returns the 50 most recently created folders in descending order of creation time.

    POST /v1_1/{cloud_name}/folders/search

  • Write

    Rename or move a folder

    Renames or moves the folder at the specified path, along with all the assets it contains, to a new path.

    PUT /v1_1/{cloud_name}/folder_operations/rename

  • Write

    Get a folder by its identifier

    Returns the details of the folder with the specified identifier, including its ancestors.

    PUT /v1_1/{cloud_name}/folders/by_id

  • Write

    Get a folder by its path

    Returns the details of the folder at the specified path, including its ancestors.

    PUT /v1_1/{cloud_name}/folders/by_path

  • Write

    Get the descendants of a folder

    Returns the descendant folders of the folder with the specified identifier, optionally filtered to a set of folder identifiers.

    PUT /v1_1/{cloud_name}/folders/descendants

  • Write

    Get the details of a single asset by body parameters

    Returns the details of a single asset identified by its public ID, delivery type, and resource type passed in the request body.

    POST /v1_1/{cloud_name}/resources/get_resource

  • Write

    Evaluate a dynamic upload-parameter expression

    Evaluates a dynamic eval expression against the supplied upload parameters and returns the resulting upload parameters.

    POST /v1_1/{cloud_name}/eval

  • Write

    Provides a powerful query interface to filter and retrieve assets and their details

    Returns a list of resources matching the specified search criteria. Uses a Lucene-like query language to filter assets by descriptive attributes (`public_id`, `asset_id`, `filename`, `display_name`, `folder` / `asset_folder`, `tags`, `context.`), file details (`resource_type`, `type`, `format`, `bytes`, `width`, `height`, `duration`, `pages`, `aspect_ratio`, `transparent`, `grayscale`), lifecycle dates (`uploaded_at`, `created_at`, `taken_at`, `updated_at`, `last_updated.`), moderation and lifecycle state (`status`, `moderation_status`, `moderation_kind`), embedded data (`image_metadata.*`), structured metadata (`metadata.`), and analysis fields (`face_count`, `colors`, `quality_score`, `illustration_score`, `accessibility_analysis.*`). Supports sorting, aggregate counts, and complex boolean expressions. Examples: `tags:shirt AND uploaded_at>1d`, `resource_type:image AND bytes>1000000`, `folder:products OR context.category:electronics`. See the [search expressions guide](https://cloudinary.com/documentation/search_expressions.md) for the full syntax and field reference.

    POST /v1_1/{cloud_name}/resources/search

  • Write

    Finds images in your asset library based on visual similarity or content

    Returns a list of resources that are visually similar to a specified image. You can provide the source image for comparison in one of three ways: - Provide a URL of an image - Specify the asset ID of an existing image - Provide a textual description

    POST /v1_1/{cloud_name}/resources/visual_search

  • Write

    Create initial backup

    Initiates an initial backup of existing assets for the active product environment. Backup for new uploads must be enabled on the product environment, and the requester must be permitted to initiate a backup.

    POST /v1_1/{cloud_name}/operations/initial_backup

  • Write

    Update a person

    Updates a recognized person's name, status, or thumbnail image. At least one of name, status, or thumbnail_asset_id must be provided. People Search must be enabled for this product environment.

    PUT /v1_1/{cloud_name}/people/{person_id}

  • Write

    Generate an image from a text prompt

    Create any image from a text description with AI: photos, illustrations, logos, icons, product shots, banners, ads, social posts, concept art, mockups, and images with readable text. One call gives you the best image models — Nano Banana, GPT Image, FLUX, Ideogram, Recraft and more. Leave out `model` and a strong default is used. **Storage is optional.** Get the image at a temporary link without saving anything to your account, or keep it in your Media Library, ready to deliver, transform and optimize. **What you get back.** Each image comes with its URL, size, format and the model that made it, either in the response or, for longer jobs, from a background task you can check or be notified about. Each generation uses Image Generation credits. To edit, restyle or combine existing images, use image-to-image (`generate-image-from-images`) instead.

    POST /v2/generate/{cloud_name}/text_to_image

  • Write

    Edit or combine images with a text prompt

    Edit, restyle or combine existing images with AI, guided by a text prompt: replace a background, add or remove objects, apply a style, make on-brand variants, keep a character or product consistent across scenes, virtual try-on, or extend an image. Pass up to 4 reference images, each a public HTTPS `url` or an `asset_id` from the user's Cloudinary account, and refer to them in the prompt as `[1]`, `[2]`, …. For a local file, upload it first and reference it by its `asset_id`. Leave out `model` and a strong default edit model is used; only edit-capable models are accepted. **Storage is optional.** Get the image at a temporary link without saving anything to your account, or keep it in your Media Library. **What you get back.** Each image comes with its URL, size, format and the model that made it, either in the response or, for longer jobs, from a background task you can check or be notified about. Each generation uses Image Generation credits.

    POST /v2/generate/{cloud_name}/image_to_image

  • Destructive

    Uploads media assets (images, videos, raw files) to your Cloudinary product environment

    Uploads media assets (images, videos, raw files) to your Cloudinary product environment. The file is securely stored in the cloud with backup and revision history. Cloudinary automatically analyzes and saves important data about each asset, such as format, size, resolution, and prominent colors, which is indexed to enable searching on those attributes. Supports uploading from: - Local file paths (SDKs/MCP server only). For MCP server path MUST start with file:// - Remote HTTP/HTTPS URLs - Base64 Data URIs (max ~60 MB) - Private storage buckets (S3 or Google Storage) - FTP addresses The uploaded asset is immediately available for transformation and delivery upon successful upload. Transform media files using transformation syntax in delivery URLs, which creates derived files accessible immediately without re-uploading the original.

    POST /v1_1/{cloud_name}/{resource_type}/upload

  • Destructive

    Upload with automatic file type detection

    Uploads a file to Cloudinary. The file type is automatically detected based on its content, so you don't need to specify the type manually.

    POST /v1_1/{cloud_name}/upload

  • Destructive

    Upload a single chunk of a large file

    Uploads a single chunk of a large file as part of a chunked upload process. This enables efficient upload of large files with the ability to resume interrupted uploads. Each request uploads one chunk of the file. It is required for any files that are larger than 100 MB. This is often relevant for video files, as they tend to have larger file sizes. Minimum chunk size is 5 MB. The `file` field accepts either the chunk bytes (multipart) or an HTTP/HTTPS URL. When a URL is supplied, Cloudinary downloads it and validates the response `Content-Length` against the chunk-size contract (exact match in the uniform-size flow; within 5 MB floor and 5 GiB cap in explicit-order mode) before storing any bytes. A mismatch aborts with 400 and persists no state. The remote server must return a `Content-Length` header; chunked transfer-encoded responses are rejected. **Explicit-order totals** (`X-Upload-Part-Number`): `X-Upload-Total-Parts` may be omitted on non-terminal chunks until the session total *N* is established by any earlier chunk that sent the header. After *N* is known, the chunk for part index *N* must include `X-Upload-Total-Parts: N`. Whenever the header appears, its value must be the same integer *N* for that `X-Unique-Upload-Id` (no conflicting totals).

    POST /v1_1/{cloud_name}/{resource_type}/upload_chunked

  • Destructive

    Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account

    Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account

    POST /v1_1/{cloud_name}/{resource_type}/rename

  • Destructive

    Destroys an asset/resource

    Destroys an asset/resource

    POST /v1_1/{cloud_name}/{resource_type}/destroy

  • Destructive

    Apply operations on an existing asset

    Applies actions such as transformations, tags, or metadata updates to an existing asset without re-uploading it. This is useful for applying new transformations, adding tags, or updating metadata on assets that are already in your cloud. Note: Always prefer delivery URL transformations over this method, unless eager transformations are specifically required.

    POST /v1_1/{cloud_name}/{resource_type}/explicit

  • Destructive

    Adds, removes, or replaces tags on multiple assets

    Applies a tag command to the given assets, addressing them by public ID. The number of tags multiplied by the number of public IDs must not exceed 10,000.

    POST /v1_1/{cloud_name}/{resource_type}/tags

  • Destructive

    Adds or clears contextual metadata on multiple assets

    Applies a contextual-metadata command to the given assets, addressing them by public ID.

    POST /v1_1/{cloud_name}/{resource_type}/context

  • Destructive

    Sets structured metadata values on multiple assets

    Assigns structured metadata field values to the given assets, addressing them by public ID. Values are merged into each asset's existing structured metadata: fields not mentioned keep their current values, and an empty value clears the field. Every referenced field must already exist in the product environment. Conditional metadata rules are evaluated as part of the update.

    POST /v1_1/{cloud_name}/{resource_type}/metadata

  • Destructive

    Delete asset by asset ID

    Deletes an asset using its immutable asset ID.

    POST /v1_1/{cloud_name}/asset/destroy

  • Destructive

    Concatenate ordered video segments into a single MP4 asset

    Accepts an ordered list of remote HTTP(S) URLs pointing to video segments and concatenates them, remuxing the result into a single MP4 asset that is uploaded to your product environment using the supplied upload parameters. Concatenation and the resulting upload happen asynchronously; supply a `notification_url` to be notified when the upload completes.

    POST /v1_1/{cloud_name}/video/concat

  • Destructive

    Updates the definition of an existing transformation

    Updates a named or unnamed transformation.

    PUT /v1_1/{cloud_name}/transformations/{transformation}

  • Destructive

    Deletes a named transformation from your account

    Delete a named or unnamed transformation. Optionally invalidate derived resources generated using the named transformation.

    DELETE /v1_1/{cloud_name}/transformations/{transformation}

  • Destructive

    Deletes an upload preset from the account

    Deletes an upload preset from the account

    DELETE /v1_1/{cloud_name}/upload_presets/{name}

  • Destructive

    Updates the configuration of an existing metadata field

    Updates the properties and configuration of the specified metadata field.

    PUT /v1_1/{cloud_name}/metadata_fields/{external_id}

  • Destructive

    Deletes a structured metadata field definition from your account

    Permanently deletes the specified metadata field and all its associated data.

    DELETE /v1_1/{cloud_name}/metadata_fields/{external_id}

  • Destructive

    Removes one or more allowed values from a metadata field's datasource

    Removes specific values from a metadata field's datasource by their external IDs.

    DELETE /v1_1/{cloud_name}/metadata_fields/{external_id}/datasource

  • Destructive

    Creates a new conditional metadata rule

    Creates a new metadata rule with the specified properties and configuration.

    POST /v1_1/{cloud_name}/metadata_rules

  • Destructive

    Updates an existing conditional metadata rule's definition

    Updates the properties and configuration of an existing metadata rule.

    PUT /v1_1/{cloud_name}/metadata_rules/{external_id}

  • Destructive

    Deletes a conditional metadata rule by its ID

    Permanently deletes a metadata rule.

    DELETE /v1_1/{cloud_name}/metadata_rules/{external_id}

  • Destructive

    Deletes a folder upload mapping

    Permanently deletes the upload mapping for the specified folder

    DELETE /v1_1/{cloud_name}/upload_mappings

  • Destructive

    Replaces all upload mappings

    Replaces all upload mappings

    PUT /v1_1/{cloud_name}/upload_mappings/replace

  • Destructive

    Deletes a notification trigger

    Deletes a trigger.

    DELETE /v1_1/{cloud_name}/triggers/{id}

  • Destructive

    Delete resources by public ID

    Deletes assets uploaded to your product environment, identified by their public IDs.

    DELETE /v1_1/{cloud_name}/resources/{resource_type}/{type}

  • Destructive

    Update asset by public ID

    Updates one or more attributes of a specified resource (asset) identified by its public ID. Note that you can also update many attributes of an existing asset using the explicit method, which is not rate limited.

    POST /v1_1/{cloud_name}/resources/{resource_type}/{type}/{public_id}

  • Destructive

    Updates an existing asset's metadata, tags, and other attributes using its asset ID

    Updates one or more attributes of a specified resource (asset) by its asset ID. This enables you to update details of an asset by its unique and immutable identifier, regardless of public ID, display name, asset folder, resource type or delivery type. Note that you can also update attributes of an existing asset using the explicit API endpoint.

    PUT /v1_1/{cloud_name}/resources/{asset_id}

  • Destructive

    Delete backed up versions

    Deletes specific backed up versions of an asset identified by asset ID. This operation is irreversible and deleted versions cannot be recovered.

    DELETE /v1_1/{cloud_name}/resources/backup/{asset_id}

  • Destructive

    Delete asset relations by asset ID

    Unrelates the asset from other assets, specified by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or delivery type. This is a bidirectional process, meaning that the asset will also be removed as a related_asset from all the other assets specified.

    DELETE /v1_1/{cloud_name}/resources/related_assets/{asset_id}

  • Destructive

    Delete asset relations by public ID

    Unrelates the asset from other assets, specified by public IDs. This is a bidirectional process, meaning that the asset will also be removed as a related_asset from all the other assets specified.

    DELETE /v1_1/{cloud_name}/resources/related_assets/{resource_type}/{type}/{public_id}

  • Destructive

    Delete custom streaming profile or revert built-in profile to the original settings

    Delete custom streaming profile or revert built-in profile to the original settings

    DELETE /v1_1/{cloud_name}/streaming_profiles/{name}

  • Destructive

    Deletes an existing folder from your media library

    Deletes a folder and all assets within it.

    DELETE /v1_1/{cloud_name}/folders/{folder}

  • Destructive

    Assign folder roles

    Assigns or removes folder roles for a principal (user, group, or API key). Supports all system folder roles (see [System roles reference](https://cloudinary.com/documentation/permissions_system_roles_policies#folder_roles)). Enterprise customers can also assign custom roles by ID. Note: Assigning roles to users or groups via this endpoint requires their user or group IDs, which are available through the Provisioning API (Enterprise only). Free customers can use this endpoint to assign roles only to API keys, but can assign folder roles to users and groups through the UI.

    POST /v1_1/{cloud_name}/folder_operations/invite/{folder_id}

  • Destructive

    Delete derived resources

    Deletes derived resources by derived resource ID

    DELETE /v1_1/{cloud_name}/derived_resources

  • Destructive

    Invalidate derived assets by delivery URLs

    Deletes and invalidates the cached derived assets that back the specified delivery URLs.

    DELETE /v1_1/{cloud_name}/derived_resources/invalidate_by_urls

  • Destructive

    Update the details of a single asset by body parameters

    Updates the details of an existing asset (such as tags, contextual metadata, structured metadata, and moderation status) identified by its public ID, delivery type, and resource type passed in the request body.

    POST /v1_1/{cloud_name}/resources/update

ai-video-analysis

  • Read

    Poll an AI Video Analysis job

    Returns the current status of an analysis job. When the status is `completed`, the response includes the generated visual transcript file's asset details and delivery URL.

    GET /v2/video/{cloudName}/ai_video_analysis/{jobId}

  • Write

    Create an AI Video Analysis job

    Submits a stored video asset for visual analysis and returns a job you can poll for the result.

    POST /v2/video/{cloudName}/ai_video_analysis

analysis

  • Read

    Get analysis task status

    Get the status of an analysis task.

    GET /v2/analysis/{cloud_name}/tasks/{task_id}

  • Write

    Analyze - AI Vision General

    The General mode serves a wide array of applications by providing detailed answers to diverse questions about an image. Users can inquire about any aspect of an image, such as identifying objects, understanding scenes, or interpreting text within the image.

    POST /v2/analysis/{cloud_name}/analyze/ai_vision_general

  • Write

    Analyze - AI Vision Moderation

    The Moderation mode accepts multiple questions about an image, to which the response provides concise answers of "yes," "no," or "unknown." This functionality allows for a nuanced evaluation of whether the image adheres to specific content policies, creative specs, or aesthetic criteria.

    POST /v2/analysis/{cloud_name}/analyze/ai_vision_moderation

  • Write

    Analyze - AI Vision Tagging

    The Tagging mode accepts a list of tag names along with their corresponding descriptions. If the image matches the description, which may encompass various elements, it will be appropriately tagged. This approach enables customers to align with their own brand taxonomy, offering a dynamic, flexible, and open method for image classification.

    POST /v2/analysis/{cloud_name}/analyze/ai_vision_tagging

  • Write

    Analyze - Captioning

    Provides a caption for an image.

    POST /v2/analysis/{cloud_name}/analyze/captioning

  • Write

    Analyze - Cld-Fashion

    Analyze an image using the [Cld-Fashion](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. Cloudinary's fashion model is specifically dedicated to items of clothing. The response includes attributes of the clothing identified, for example whether the garment contains pockets, its material and the fastenings used.

    POST /v2/analysis/{cloud_name}/analyze/cld_fashion

  • Write

    Analyze - Cld-Text

    Analyze an image using the [Cld-Text](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. Cloudinary's text model tells you if your image includes text, and where it's located. Used with image tagging, you can then search for images that contain blocks of text. Used with object-aware cropping, you can choose to keep only the text part, or specify a crop that avoids the text.

    POST /v2/analysis/{cloud_name}/analyze/cld_text

  • Write

    Analyze - Coco

    Analyze an image using the [Coco](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. The [Common Objects in Context](https://cocodataset.org/) model contains just 80 common objects.

    POST /v2/analysis/{cloud_name}/analyze/coco

  • Write

    Analyze - Google Logo Detection

    Detects popular product logos within an image.

    POST /v2/analysis/{cloud_name}/analyze/google_logo_detection

  • Write

    Analyze - Google Tagging

    Provides tags for an image using Google's tagging service.

    POST /v2/analysis/{cloud_name}/analyze/google_tagging

  • Write

    Analyze - Human Anatomy

    Analyze an image using the [Human Anatomy](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. Cloudinary's human anatomy model identifies parts of the human body in an image. It works best when the majority of a human body is detected in the image.

    POST /v2/analysis/{cloud_name}/analyze/human_anatomy

  • Write

    Analyze - Image Quality Analysis

    Analyze an image using the [Image Quality Analysis](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#image_quality_analysis) model.

    POST /v2/analysis/{cloud_name}/analyze/image_quality

  • Write

    Analyze - Lvis

    Analyze an image using the [Lvis](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. The [Large Vocabulary Instance Segmentation](https://www.lvisdataset.org/) model contains thousands of general objects.

    POST /v2/analysis/{cloud_name}/analyze/lvis

  • Write

    Analyze - Shop Classifier

    Analyze an image using the [Shop Classifier](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. Cloudinary's shop classifier model detects if the image is a product image taken in a studio, or if it's a natural image.

    POST /v2/analysis/{cloud_name}/analyze/shop_classifier

  • Write

    Analyze - Unidet

    Analyze an image using the [Unidet](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. The [UniDet](https://github.com/xingyizhou/UniDet) model is a unified model, combining a number of object models, including [Objects365](https://www.objects365.org/overview.html), which focuses on diverse objects in the wild.

    POST /v2/analysis/{cloud_name}/analyze/unidet

  • Write

    Analyze - Watermark Detection

    Analyze an image using the [Watermark Detection](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#watermark_detection) detection model.

    POST /v2/analysis/{cloud_name}/analyze/watermark_detection

image-to-video

  • Read

    Poll a video generation job

    Returns the current status of a generation job. When the status is `completed`, the response includes the generated video's asset details and delivery URL.

    GET /v2/video/{cloudName}/image_to_video/generate/{jobId}

  • Read

    Get a list of image to video prompts

    Returns all saved image-to-video prompts for your product environment.

    GET /v2/video/{cloudName}/image_to_video/prompts

  • Read

    Get an image to video prompt

    Returns a single saved prompt by its ID.

    GET /v2/video/{cloudName}/image_to_video/prompts/{promptId}

  • Write

    Create a video generation job

    Submits an image and prompt for video generation and returns a job you can poll for the result.

    POST /v2/video/{cloudName}/image_to_video/generate

  • Write

    Create an image to video prompt

    Saves a reusable prompt with a display name so you can apply it to future generations.

    POST /v2/video/{cloudName}/image_to_video/prompts

  • Write

    Update an image to video prompt

    Updates the display name and/or prompt text of a saved prompt.

    PATCH /v2/video/{cloudName}/image_to_video/prompts/{promptId}

  • Destructive

    Delete an image to video prompt

    Permanently deletes a saved prompt by its ID.

    DELETE /v2/video/{cloudName}/image_to_video/prompts/{promptId}

permissions

  • Read

    Get system roles and policies catalog

    Retrieves the catalog of predefined system roles and their associated policies.

    GET /v2/accounts/permissions/public/catalog

  • Read

    Validate a Cedar policy

    Validate a Cedar policy

    POST /v2/accounts/permissions/public/validate

  • Read

    Get Cedar schema

    Get Cedar schema

    GET /v2/accounts/permissions/public/schema

  • Read

    Get system policies

    Retrieve all system-defined permission policies. Optionally filter the results by `scope_type` (account or product environment) and/or `permission_type` (global or content-specific). **Note:** If `scope_type` isn't specified as `prodenv`, the account-level policies will be returned.

    GET /v2/accounts/{account_id}/permissions/policies/system

  • Read

    Get custom policies

    Retrieve all custom permission policies defined for a specific scope. The scope can be at the account level or within a specific product environment. **Notes:** * If `scope_type` isn't specified as `prodenv`, the account-level policies will be returned. * If `scope_type` is specified as `prodenv`, `scope_id` is required.

    GET /v2/accounts/{account_id}/permissions/policies/custom

  • Read

    Get custom policy

    Get a specific custom policy.

    GET /v2/accounts/{account_id}/permissions/policies/custom/{policy_id}

  • Read

    Get effective policies

    Retrieve all roles (along with their system permission policies) associated with principals, and all custom permission policies directly added to principals, all within a specified scope. Optionally specify a principal to only include roles and policies associated with that principal.

    GET /v2/accounts/{account_id}/permissions/policies/effective

  • Read

    Get roles

    Retrieve all system and custom roles of a specific `permission_type` (global or content-specific). Optionally filter by `scope_type`, `management_type`, and `policy_parameters`.

    GET /v2/accounts/{account_id}/permissions/roles

  • Read

    Get role

    Get a specific system or custom role.

    GET /v2/accounts/{account_id}/permissions/roles/{role_id}

  • Read

    Get a principal's roles

    Retrieve all roles associated with a specific principal.

    GET /v2/accounts/{account_id}/permissions/principal_roles

  • Read

    Inspect

    Retrieves principals and their assigned roles within a specified scope, based on query filters. Use this endpoint to determine which users, groups, API keys, or account API keys have roles applied at: * A specific `scope_type` ("account" or "prodenv") * A specific `scope_id` (for product environments) * Optional content filters (such as `folder_id`, `collection_id`, or `param_key` / `param_value`) * Optional `principal_type` (and `principal_id`) The response includes all principals that match the specified filters, along with the roles applied to them within that context. This endpoint is useful when you want to: * Audit who has access within a given scope * Identify all principals assigned to roles for a specific folder, collection, asset, or product environment * Retrieve role assignments dynamically based on filtering criteria

    GET /v2/accounts/{account_id}/permissions/principal_roles/inspect

  • Read

    Inspect multiple

    Retrieves role assignments for a specified list of principals within a shared scope and optional policy parameters. Use this endpoint when you already know which principals you want to evaluate and want to check their role assignments in a single request. In this request: * You explicitly provide the `principals` array in the request body. * All principals are evaluated against the same `scope_type`, optional `scope_id`, and optional `policy_parameters`. * Unlike `Inspect`, this endpoint doesn't search for matching principals. It evaluates only the principals you provide. This endpoint is useful for: * Verify role assignments for multiple specified principals at once * Comparing role assignments across specific users, groups, or keys * Reducing multiple per-principal `Inspect` calls into a single request

    POST /v2/accounts/{account_id}/permissions/principal_roles/inspect

  • Read

    Get a role's principals

    Retrieve all principals associated with a specific role.

    GET /v2/accounts/{account_id}/permissions/roles/{role_id}/principals

  • Write

    Create custom policy

    Create a new custom policy with a statement defined in Cedar. This policy specifies permissions for a principal, allowing a specific action on a designated resource, within a particular scope.

    POST /v2/accounts/{account_id}/permissions/policies/custom

  • Write

    Create custom role

    Create a new custom role.

    POST /v2/accounts/{account_id}/permissions/roles

  • Destructive

    Update custom policy

    Update a specific custom policy by providing the entire policy entity in the request body. Ensure the new `policy_statement` includes modifications. Existing permissions will be replaced with the new data. *Note:* Updating a policy with an identical `policy_statement` will trigger a 409 error.

    PUT /v2/accounts/{account_id}/permissions/policies/custom/{policy_id}

  • Destructive

    Delete custom policy

    Delete a specific custom policy.

    DELETE /v2/accounts/{account_id}/permissions/policies/custom/{policy_id}

  • Destructive

    Update custom role

    Update a specific custom role by providing all relevant details, including those you want to keep as-is. *Note:* Updating a role with a name that already exists will trigger a 409 error.

    PUT /v2/accounts/{account_id}/permissions/roles/{role_id}

  • Destructive

    Delete custom role

    Delete a specific custom role.

    DELETE /v2/accounts/{account_id}/permissions/roles/{role_id}

  • Destructive

    Assign roles to a principal

    Add or remove roles associated with a principal.

    PUT /v2/accounts/{account_id}/permissions/principal_roles

  • Destructive

    Assign principals to a role

    Add or remove principals associated with a role.

    PUT /v2/accounts/{account_id}/permissions/roles/{role_id}/principals

provisioning

  • Read

    Get product environments

    Return an array of all product environments, or if conditions are specified, return the relevant product environments.

    GET /v1_1/provisioning/accounts/{account_id}/sub_accounts

  • Read

    Get product environment

    Retrieve a specific product environment.

    GET /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}

  • Read

    Get access keys

    Retrieve an array of all access keys for a product environment.

    GET /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}/access_keys

  • Read

    Get users

    Returns an array of all users in the account, or if conditions are specified, returns the relevant users.

    GET /v1_1/provisioning/accounts/{account_id}/users

  • Read

    Get user

    Retrieve a specific user.

    GET /v1_1/provisioning/accounts/{account_id}/users/{user_id}

  • Read

    Get user groups

    Retrieve the groups that a specific user belongs to.

    GET /v1_1/provisioning/accounts/{account_id}/users/{user_id}/groups

  • Read

    Get user sub-accounts

    Retrieve the product environments (sub-accounts) that a specific user has access to.

    GET /v1_1/provisioning/accounts/{account_id}/users/{user_id}/sub_accounts

  • Read

    Get User Groups

    Retrieve an array of all user groups in the account.

    GET /v1_1/provisioning/accounts/{account_id}/user_groups

  • Read

    Get User Group

    Retrieve a specific user group.

    GET /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}

  • Read

    Get Users in User Group

    Retrieve the users in the group with the specified ID.

    GET /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}/users

  • Read

    Get billing usage information

    Retrieve billing usage metrics for your account and product environments, including storage, bandwidth, impressions, and transformations. If `year` is provided: - **Annual subscription**: Returns the single annual usage cycle that began in the specified year (if any). - **Monthly subscription**: Returns all monthly usage cycles that began in the specified year. If `year` is not provided: - Returns usage for the year in which the current active subscription period began. - If no active subscription exists, an empty list is returned. **Note**: Usage metrics are updated daily, so calling this endpoint once per day gives you the latest data.

    GET /v1_1/provisioning/accounts/{account_id}/billing_usage

  • Write

    Create product environment

    Create a new product environment. Any users that have access to all product environments will also automatically have access to the new product environment.

    POST /v1_1/provisioning/accounts/{account_id}/sub_accounts

  • Write

    Generate an access key

    Generate a new access key.

    POST /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}/access_keys

  • Write

    Create user

    Create a new user.

    POST /v1_1/provisioning/accounts/{account_id}/users

  • Write

    Create User Group

    Create a new user group for the account.

    POST /v1_1/provisioning/accounts/{account_id}/user_groups

  • Write

    Update User Group

    Update the name of a specified user group.

    PUT /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}

  • Write

    Add User to User Group

    Add a user to a group with the specified ID.

    POST /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}/users/{user_id}

  • Destructive

    Update product environment

    Update the details of a product environment.

    PUT /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}

  • Destructive

    Delete product environment

    Delete a specific product environment.

    DELETE /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}

  • Destructive

    Delete access key by name

    Delete a specific access key by name.

    DELETE /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}/access_keys

  • Destructive

    Update an access key

    Update the name and/or status of an existing access key.

    PUT /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}/access_keys/{key}

  • Destructive

    Delete access key

    Delete a specific access key.

    DELETE /v1_1/provisioning/accounts/{account_id}/sub_accounts/{sub_account_id}/access_keys/{key}

  • Destructive

    Update user

    Update the details of a user.

    PUT /v1_1/provisioning/accounts/{account_id}/users/{user_id}

  • Destructive

    Delete user

    Delete a specific user.

    DELETE /v1_1/provisioning/accounts/{account_id}/users/{user_id}

  • Destructive

    Delete User Group

    Delete a user group with the specified ID.

    DELETE /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}

  • Destructive

    Remove User from User Group

    Remove a user from a group with the specified ID.

    DELETE /v1_1/provisioning/accounts/{account_id}/user_groups/{group_id}/users/{user_id}

video-canvas

  • Read

    List applets

    Returns the account's saved Video Canvas applets as summaries, without their inputs, blocks, connections, or outputs.

    GET /v2/video/{cloudName}/video_canvas/applets

  • Read

    Get an applet

    Returns a single applet with its full content, including its inputs, blocks, connections, and outputs.

    GET /v2/video/{cloudName}/video_canvas/applets/{appletId}

  • Write

    Create an applet

    Creates an applet from its content (inputs, blocks, connections, and outputs). Cloudinary compiles the action blocks into a named transformation and returns the stored applet.

    POST /v2/video/{cloudName}/video_canvas/applets

  • Destructive

    Replace an applet's content

    Replaces the full content of an existing applet and recompiles its backing named transformation.

    PUT /v2/video/{cloudName}/video_canvas/applets/{appletId}

  • Destructive

    Delete an applet

    Deletes an applet and its stored content. The named transformation that backs the applet isn't deleted, so delivery URLs and SDK calls that reference it keep working. To stop delivering the transformation, delete the named transformation separately.

    DELETE /v2/video/{cloudName}/video_canvas/applets/{appletId}

video-live-streaming

  • Read

    Get a list of live streams

    Get a list of live streams

    GET /v2/video/{cloudName}/live_streams

  • Read

    Get a single live stream

    Get a single live stream

    GET /v2/video/{cloudName}/live_streams/{liveStreamId}

  • Read

    Get a list of live stream outputs

    Get a list of live stream outputs

    GET /v2/video/{cloudName}/live_streams/{liveStreamId}/outputs

  • Read

    Get a single live stream output

    Get a single live stream output

    GET /v2/video/{cloudName}/live_streams/{liveStreamId}/outputs/{liveStreamOutputId}

  • Write

    Create a new live stream

    Create a new live stream

    POST /v2/video/{cloudName}/live_streams

  • Write

    Update a live stream

    Update a live stream

    PATCH /v2/video/{cloudName}/live_streams/{liveStreamId}

  • Write

    Manually activate a live stream

    Manually activate a live stream

    POST /v2/video/{cloudName}/live_streams/{liveStreamId}/activate

  • Write

    Create a new live stream output

    Create a new live stream output

    POST /v2/video/{cloudName}/live_streams/{liveStreamId}/outputs

  • Write

    Update a live stream output

    Update a live stream output

    PATCH /v2/video/{cloudName}/live_streams/{liveStreamId}/outputs/{liveStreamOutputId}

  • Destructive

    Delete a live stream

    Delete a live stream

    DELETE /v2/video/{cloudName}/live_streams/{liveStreamId}

  • Destructive

    Manually idle a live stream

    Manually idle a live stream

    POST /v2/video/{cloudName}/live_streams/{liveStreamId}/idle

  • Destructive

    Delete a live stream output

    Delete a live stream output

    DELETE /v2/video/{cloudName}/live_streams/{liveStreamId}/outputs/{liveStreamOutputId}

See How connections work for access and permissions, or browse all integrations.