API Response Reference

The following table summarizes the attributes that can potentially appear in the response when you run a Cloudinary API method call.

You can also see example responses throughout the Upload API Reference and Admin API Reference.

Field Type Description
access_mode String The accessibility mode of the media asset: public, or authenticated.
aggregations Data The aggregation counts data requested when using the Search API. For aggregation fields without discrete values, the results are divided into categories:
- bytes are divided into small (<500 kb), medium (500 - 5mb), large (5mb - 100 mb), and huge (>100 mb).
- duration is divided into short (< 3 minutes), medium (3-12 min), and long (> 12 min).
audio Data The audio information of the media asset, including the codec, bit_rate, frequency, channels, and channel_layout.
backup Boolean Indicates whether the asset is backed up to secondary storage.
bit_rate Number The bitrate of the video.
bytes Number The size of the media asset in bytes.
colors Data The color histogram of the first 32 colors in the image. If all colors are opaque, then 6-digit RGB hex values are returned, but if one or more colors contain an alpha channel, then 8-digit RGBA hex values are returned.
context Data The key-value pairs of general textual context metadata attached to the media asset.
coordinates Data The coordinates of a single region contained in an image that is subsequently used for cropping the image using the custom gravity mode. The region is specified by the X & Y coordinates of the top left corner and the width & height of the region.
created_at String The UTC date and time when the asset was originally uploaded in ISO8601 syntax: [yyyy-mm-dd]T[hh:mm:ss]Z.
data Data The requested information when managing adaptive streaming profiles.
delete_token String A token that can be used to delete the uploaded media asset within the next 10 minutes using an unauthenticated API deletion request.
deleted Data The list of media assets requested for deletion, with the status of each asset (deleted unless there was an issue).
derived Data The list of derived assets generated (and cached) from the original media asset, including the transformation applied, size and URL for accessing the derived media asset.
duration Number The duration of the media asset in seconds (video or audio).
eager Data The derived images generated as per the requested eager transformations of the method call.
etag String Used to determine whether two versions of an asset are identical.
faces Data The coordinates of the faces automatically detected in an image. Each face is specified by the X & Y coordinates of the top left corner and the width & height of the face.
folders Data A list of all root folders or the subfolders of a specified root folder. Each folder is listed with a name and path.
format String The format of the media asset.
frame_rate Number The frame rate of the video.
grayscale Boolean If the image only contains a single grayscale channel.
height Number The height of the media asset in pixels.
illustration_score Number The likelihood that the image is an illustration as opposed to a photograph. A value between 0 (photo) and 1.0 (illustration).
image_metadata Data The IPTC, XMP, and detailed Exif metadata of the image.
info Data Any requested information from executing one of the Cloudinary Add-ons on the media asset.
last_updated String The last time the account was updated. This is one of the details returned when requesting account usage details.
mappings Data A listing of all auto-upload mappings by folder and its mapped template (URL).
message String Any additional information regarding the API method request. For example, this could be a confirmation message (e.g., updated) or an indication of any error encountered (e.g., Resource not found).
moderation Data The current moderation status and details if any.
next_cursor String When a request has more results to return than max_results, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify the value as the next_cursor parameter of the following request (for methods supporting the parameter).
original_filename String The name of the media asset when originally uploaded. Relevant when delivering assets as attachments (setting the flag transformation parameter to attachment).
pages Number The number of pages in the image: included if the image has multiple pages (e.g., PDF or animated GIF).
partial Boolean When a request has more results to return than max_results, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify the value as the next_cursor parameter of the following request (for methods supporting the parameter).
phash String The perceptual hash (pHash) of the image acts as a fingerprint that allows checking image similarity.
pixels Number The number of pixels in the image (width x height).
placeholder Boolean Indicates if a placeholder (default image) is currently used instead of displaying the image (due to moderation).
plan String The Cloudinary Plan associated with the account. One of the details returned when requesting account usage details.
presets Data A listing of all upload presets. Each preset has the following attributes:
- name (String) The name of the preset.
- unsigned (Boolean) Indicates whether the preset can be used for unsigned uploads.
- settings (Data) Any upload parameters that are applied when uploading assets with this preset.
predominant Data The predominant colors in the image according to both a Google palette and a Cloudinary palette.
public_id String The public identifier that is used for accessing the media asset. The Public ID may contain a full path including folders separated by a slash (/).
resources Data The list of media assets matching the specified criteria.
resource_type String The type of media asset: image, raw, or video.
secure_url String The HTTPS URL for securely accessing the media asset.
semi_transparent Boolean If the image has an alpha (transparency) channel.
signature String The signature for verifying the response is a valid response from Cloudinary.
transformations Data A listing of all transformations specified in your account. Each transformation has the following fields:
- name (String) The name of a named transformation (e.g., t_trans1) or the transformation itself as expressed in a dynamic URL (e.g., w_110,h_100,c_fill).
- allowed_for_strict (Boolean) Indicates whether the transformation can be used when strict transformations are enabled.
- used (Boolean) Indicates whether the transformation has been used to create a derived asset.
- named (Boolean) Indicates whether the transformation is a named transformation.
tags String The list of tags currently assigned to the media asset.
time Number The time taken to process the request in seconds.
total_count Number The total number of assets matching the search criteria.
type String The accessibility type of the media asset: upload, private or authenticated
url String The HTTP URL for accessing the media asset.
version Number The current version of the image used in the Media Library, Admin API, and delivery URLs.
video Data The video encoding information, including pix_format, codec, level, and bit_rate.
width Number The width of the media asset in pixels.