Cloudinary API response reference

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

For more information on API responses, see Upload response. 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 resource while still using the 'upload' type in delivery URLs: public, or authenticated.
aggregations Data The aggregation counts data requested. 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)
bytes Number The size of the resource 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 resource.
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 resource was originally uploaded in ISO8601 syntax: [yyyy-mm-dd]T[hh:mm:ss]Z.
delete_token String A token that can be used to delete the uploaded resource within the next 10 minutes using an unauthenticated API deletion request.
deleted Data The list of resources requested for deletion, with the status of each resource (deleted unless there was an issue).
derived Data The list of derived images generated (and cached) from the resource, including the transformation applied, size and URL for accessing the derived resource.
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 a resource 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.
format String The format of the resource file.
grayscale Boolean If the image only contains a single grayscale channel.
height Number The height of the resource.
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 resource.
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 file when originally uploaded. Relevant when delivering resources 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).
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 resource. The Public ID may contain a full path including folders separated by a slash (/).
resources Data The list of resources matching the specified criteria.
resource_type String The type of resource: image, raw, or video.
secure_url String The HTTPS URL for securely accessing the resource.
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.
tags String The list of tags currently assigned to the resource.
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 resource: upload, private or authenticated
url String The HTTP URL for accessing the resource.
version Number The current version of the image used in the Media Library, Admin API, and delivery URLs.
width Number The width of the resource.