Download OpenAPI specification:Download
The seo-name
doesn't have a functional impact on the image, but is provided to allow for adding SEO value to
asset URLs. The assetId
is an opaque string defined by the content repository that can be used to target
the asset resource.
In the URL construction, an SEO name and an output image format must be provided.
Additional transformations to be applied on that output can (optionally) be specified as query parameters, and the syntax and examples are listed in the Query Parameters section of this document.
To name a few:
crop
height
width
quality
smartcrop
blur
sharpen
auto-format
query parameter to false
.
quality
and max-quality
for additional information on tweaking this behaviour.
layers
object or integer Specifies the width of the output image in pixels. This parameter allows you to control the horizontal dimension of either the final output image or a specific layer. The width must be a positive integer (minimum value: 1). When used in combination with the height parameter, the aspect ratio of the original image is preserved. This means the actual output width may be smaller than the requested value to preserve aspect ratio. If not defined, the image width defaults to a maximum of 2048 pixels. Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
quality | integer [ 1 .. 100 ] Specifies the compression quality for the image. Quality value ranges from 1 to 100, where 100 is the highest quality (least compression) and 1 is the lowest quality (highest compression). A higher quality value results in better image quality but larger file size, while a lower value reduces file size at the cost of image quality. Note: For dynamic quality based on network conditions, use Example:
Only the global | |||||||||||
max-quality | integer [ 1 .. 100 ] Specifies the maximum quality for the image when delivery-engine dynamically adjusts the quality of the image based on the client's network bandwidth. The value ranges from 1 to 100, where 100 is the highest quality (least compression) and 1 is the lowest quality (highest compression). By default, the value is set to Unlike the static Note: If Example:
| |||||||||||
object or string Applies intelligent cropping to automatically identify and preserve visually most important areas of the image for a given crop-region. This operation uses AI-powered content-aware cropping to ensure that key elements like faces, text, or focal points are retained in the output. The smartcrop parameter expects that named-smartcrop-profiles exist and have been applied to the asset. Those predefined profile names - specifying the target dimensions and aspect ratio of the cropped image - can be supplied as values of this parameter. The cropping can be applied either to a specific layer or to the final output image. Examples without layer:
Examples when used with a layer named
Only one of NOTE: Specifying an unresolvable smartcrop profile-name (the one that hasn't been defined, or hasn't been applied to the asset being requested) will lead to an error response. | ||||||||||||
object or number Device Pixel Ratio (DPR) (also known as CSS pixel ratio) is the relation between a device's physical pixels and logical pixels. Enabling Device Pixel Ratio optimization with HTML5 Responsive Imaging techniques renders the image at the native resolution of the screen which makes it sharp.
For more information about DPR and how it affects image resolution, see MDN Documentation for devicePixelRation property of browser- Examples without layerName:
Examples when used with a layer named
| ||||||||||||
object or integer Specifies the height of the image or a specific layer in pixels. When applied to the final output image or a layer, the image is scaled to match the specified height while maintaining the aspect ratio. The value must be a positive integer (minimum: 1 pixel). NOTE: If not defined, the height is automatically scaled to maintain aspect ratio based on the Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
object or boolean Applies a sharpening filter to enhance the edges and details in the image. The sharpening is applied either to a specific layer or to the final output image after all scaling operations are complete. When enabled, this operation increases the contrast between adjacent pixels to make the image appear more crisp and detailed. Examples without layerName:
Examples when used with a layer named
Only one of | ||||||||||||
object or integer Applies a blur filter to soften the image. The blur can be applied either to a specific layer (when layerName is provided) or to the final output image (when no layerName is specified). The radius parameter determines the strength of the blur effect in pixels relative to the final output image, with a value between 0 and 100 pixels. Examples without layerName:
Examples when used with a layer named
| ||||||||||||
object or Array of strings Crop is specified by four comma-separated values, each a number with up to two digits after the decimal point, followed by First two specify the origin (top, left) of the desired cropped region as percentages of width and height of the original image, respectively. Last two specify the size of the cropped region relative to original dimensions of the asset. A valid crop region MUST meet both of the following constraints:
Requests which don't meet aforementioned constraints will fail. Examples:
| ||||||||||||
object or string Image Preset represents a predefined collection of sizing and formatting modifiers for output image. Image Preset is a feature provided in AEM Assets. Post generation of a preset, it can be applied to the output image by specifying the preset name in this modifier. To generate a preset, please refer to the documentation here. Examples without layer:
Examples when used with a layer named
| ||||||||||||
layers | string Layers allow composition of a single output image from multiple segregations, each of which may have specific operations applied to them. Search for The layers which segregate the operations (and are finally aggregated to compose the single output image) are addressed by the names in the value of this parameter. These names are then used in rest of the parameters (which can be applied to layers) in the URL. The names are to be separated by the Layer names are case-sensitive and can have any alphanumeric characters (a-z, A-Z, 0-9). NOTE: NOTE: Nested layers are not supported, and the layers parameter can not applied to any other layer. e.g., a request for a final output image composed of two layers. layers=topa request for a final output image composed of three layers. layers=base|mid|topa request for a final output image composed of three layers, but the base layer is omitted. layers=mid|top | |||||||||||
object or object Specifies the resizing behavior when fitting the image within the output dimensions specified with In the following description of the mode options, it is assumed that
It takes the following values:
The color and transparency of the whitespace fill is determined by Examples without layer:
Examples when used with a layer named
NOTE: Attempting to apply | ||||||||||||
(ColorFormatString (ColorFormatString (string) or ColorFormatString (string) or ColorFormatString (string) or ColorFormatString (string))) or object Specifies the background color for the transparent areas of the image or selected layer. This operation takes following parameter values:
Defaults to fully transparent.
Composite Imaging - Usage with
layers background-color can be used with and without addressing a specific, named layer.
However, based on the operations performed on the implicit base layer, background-color 's behaviour can help achieve additional effects in the composite images.
Certain operations can introduce transparent pixels (padding, see fit ) beyond the bounds of the image that forms the base layer. In such cases, specifying background-color without any layer qualifier allows specifying the color to apply to the padding.
More concretely:
Examples without layer name:
Examples with layer name:
| ||||||||||||
(ColorFormatString (ColorFormatString (string) or ColorFormatString (string) or ColorFormatString (string) or ColorFormatString (string))) or object Specifies the foreground color for the image or selected layer. This operation takes following parameter values:
Defaults to fully transparent. Examples without layer name:
Examples with layer name:
| ||||||||||||
auto-format | boolean Controls the behaviour of browser format conversion for Smart Imaging capabilities. When The default value is For example,
Examples:
| |||||||||||
object or object Applies an Unsharp Masking filter on the output image to produce a sharpening effect. The effect can be tuned for intensity, radius (measured in pixels), and a threshold of contrast (beyond which the effect is ignored). This modifier uses the same options as Photoshop's "Unsharp Mask" filter. This operation accepts following parameters in the value:
Examples without layer:
Examples when used with a layer named
| ||||||||||||
attachment | string Setting this parameter to Default is Example: attachment=true | |||||||||||
object or string Flips (mirrors) the image or a specific layer horizontally, vertically, or both. This operation is useful for adjusting the orientation of content within layers. Supported values:
Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
object or integer Rotates the image or a specific layer by a fixed angle in clockwise direction. The rotation is performed around the center point of the image or layer. Rotation angle must be a multiple of 90 degrees and can be either of '90', '180', or '270' degrees clockwise. Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
fallback | string
Specifies the fallback image to be used when the requested image cannot be found. This is useful for substituting missing images with default images. If the original image does not exist and no fallback is specified, an error is returned. Important: If the fallback image itself does not exist, an error is returned. Examples without layer:
NOTE: When a fallback image is used, it replaces the missing image while maintaining the original request's attributes for the layer. | |||||||||||
Array of FourTuple (integers) or Array of FourTupleRelative (strings) or object
Adds additional pixels around a layer (e.g., adding a border) or makes the layer smaller by clipping-off pixels. The extend operation is applied to the output image or layer after other modifiers have been applied. The default value is The extended area is filled with Can be specified as:
Examples without layer:
Examples when used with a layer named
| ||||||||||||
string or object
Specifies one or more clipping paths to be applied to the A clipping path is a vector path or shape used to isolate a portion of an image. Some image formats (such as TIFFs, PSDs, etc.) can embed clipping paths within the image-binary and identify them by names (ASCII strings). This modifier allows selection of named clipping paths as embedded in the image and applies them to the specified layer. Normal vs Inverted Clipping:
More than one clipping path name (separated by Any clipping path names not found in the image are ignored when generating final output. If the intersection of selected clipping paths is an empty path, then the complete modifier is ignored. Examples:
| ||||||||||||
integer or object
Allows increasing or decreasing the transparency of the output image. Examples without layer:
Examples when used with a layer named
| ||||||||||||
object
Controls the visibility of a layer without modifying the request URL structure. This is useful for:
Examples:
| ||||||||||||
object or boolean
Inverts each color component for a negative image effect. Examples without layer:
Examples when used with a layer named
| ||||||||||||
object or object
Colorizes the image data while preserving shadows and highlights. Colorize accepts the following parameter values:
The second parameter specifies whether the brightness of the source image should be adjusted before colorizing. Specify Set the contrast value to The colorizing algorithm uses only the luminance information in the image data. This conversion to grayscale is simple and not color-managed. Properties:
Colorization is disabled by default. Examples without layer:
Examples when used with a layer named
| ||||||||||||
integer or object
Decreases or increases the image brightness. The adjustment range is from -100 to +100, where -100 is the darkest and +100 is the brightest. The default value is 0, which means no change in brightness. Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
integer or object
Adjusts the image contrast by increasing the brightness of pixels with more than 50% brightness, and reducing the brightness of pixels with less than 50% brightness. The adjustment range is from -100 to +100, where -100 provides the lowest contrast and +100 provides the highest contrast. The default value is 0, which means no change in contrast. Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
string or object
Specifies how certain operations will behave if the image has a mask. This modifier allows specifying whether the operations that take Following modifiers can alter their output when applied alongside
If no value is provided, The following table illustrates the effect depending on availability and type of the mask (alpha channel) associated with the source image: Mask Types:
Examples without layer:
Examples when used with a layer named
Only one of | ||||||||||||
object or integer
Changes the saturation of each visible pixel of the layer or output image. This allows for adjusting the color intensity of the image. The saturation value can be an integer between -100 and +100:
Examples without layer:
Examples when used with a layer named
| ||||||||||||
object or integer
Shifts the hue of each visible pixel of the layer or output image by the specified amount. It takes value adjustment in degrees (-180…+180 int). Properties: Applies to the current layer or to the output image. CMYK images or layers are converted to RGB before the operation is applied. Examples without layer:
Examples when used with a layer named
| ||||||||||||
object or string
Adds random noise to the foreground image data. Default value is 0 (no noise applied). This operation takes following parameter values:
Examples without layer:
Examples when used with a layer named
Note: The | ||||||||||||
object
Specifies the type of blending when there are multiple layers. Simulates commonly used blending modes available in Photoshop. Value can be one of
Examples:
| ||||||||||||
object or integer
Applies morphological erosion operation to pixels in the image. The value is in pixels relative to the output image. This modifier performs an erosion (contraction) of the features in the image. See NOTE: Specifying
| ||||||||||||
object or integer
Applies morphological dilation operation to pixels in the image. The value is in pixels relative to the output image. This modifier performs a dilation (expansion) of the features in the image. See NOTE: Specifying Examples without layer:
| ||||||||||||
object
Specifies the position of the center of a given layer relative to center of the base layer. The base layer is the asset specified by Can be specified as pixel offset or normalized offset from this layer's center to the base layer's center. Can be specified as:
Positive values move the layer towards the right/bottom, and negative towards the left/top. With relative coordinates, 50p,50p moves the layer by half the base layer width and height down and right. Examples:
| ||||||||||||
object
Specifies the assetId to be used as the source for a specific layer. The layer name is case-sensitive. Can only be used with a layer. Examples:
NOTE: This can be only used with | ||||||||||||
object or string
Crop to the bounding box of one or more embedded named paths in the source image. This cropping, in turn, changes the size of the image. Key features:
Examples:
Note: This operation is ignored if:
| ||||||||||||
print-resolution | integer >= 1
Defines the print resolution value of the output image. Setting the print resolution does not change the pixel size of the output image. Examples:
|
If-None-Match | string The For more details, please head over to RFC9110. |
Web-optimized version of the asset
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
This is a convenience API for /adobe/assets/{assetId}/as/{seoname}.{format}?...
that applies following defaults:
format
=> avif
(based on image-characteristics, browser-capabilities and license-entitlements, falls back to an appropriate format (webp
/png
/jpeg
) if avif-output can't be delivered. See auto-format
and format
for more details)quality
=> 65
width
=> 1024
If-None-Match | string The For more details, please head over to RFC9110. |
Web-optimized version of the asset
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The Original Asset Delivery API accepts an asset ID corresponding to the asset and delivers the bitstream as-is (as it was uploaded). This is a convenience API for /adobe/assets/{assetId}/renditions/{renditionName}/as/{seoname}
with renditionName
defaulting to original
.
If-None-Match | string The For more details, please head over to RFC9110. |
Original binary of the asset
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The Asset Rendition Delivery API accepts an asset ID corresponding to the asset and the rendition name, and delivers the selected asset's specified rendition's bitstream as-is (as present on AEM Assets authoring environment).
If-None-Match | string The For more details, please head over to RFC9110. |
Binary of the specified rendition for the selected asset
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The List Renditions API accepts an asset ID and returns the static renditions associated with the asset. A success response includes list of available renditions and their attributes.
If-None-Match | string The For more details, please head over to RFC9110. |
List of available renditions
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repo:name": "string",
- "items": [
- {
- "name": "2023-lexus-rx-450hl.jpg",
- "format": "image/jpeg",
- "size": 1,
- "dimensions": {
- "width": 1,
- "height": 1
}
}
]
}
Returns headers, including an ETag for the specified asset, which can be a lighter method of checking for the change in list of static renditions, without sending a full GET request.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The List Smart Crop API accepts an asset ID and retrieves the associated smart crops for the specified asset. A successful response returns a list of smart crops along with their attributes, providing details such as dimensions.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-None-Match | string The For more details, please head over to RFC9110. |
List of smart crops
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repo:name": "string",
- "items": [
- {
- "name": "Large",
- "dimensions": {
- "width": 1,
- "height": 1
}
}
], - "cursor": "string"
}
Returns headers, including an ETag for the specified asset, which can be a lighter method of checking for the change in list of smart crops, without sending a full GET request.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The Original Asset Delivery API accepts an asset ID corresponding to the asset and delivers the bitstream as-is (as it was uploaded).
This API is deprecated, please use /adobe/assets/{assetId}/original/as/{seo-name}
If-None-Match | string The For more details, please head over to RFC9110. |
Original binary of the asset
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Search Activated Assets
Asset Search Response
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "query": [
- {
- "and": [
- {
- "or": [
- {
- "match": {
- "text": "blue",
- "fields": [
- "metadata.repositoryMetadata.repo:name"
]
}
}, - {
- "match": {
- "text": "red",
- "fields": [
- "metadata.repositoryMetadata.repo:name"
]
}
}
]
}, - {
- "not": [
- {
- "term": {
- "metadata.repositoryMetadata.dc:format": [
- "video/mp4"
]
}
}
]
}
]
}, - {
- "range": {
- "metadata.repositoryMetadata.repo:size": {
- "gte": 3000000,
- "lte": 9000000
}
}
}
], - "orderBy": "metadata.repositoryMetadata.repo:size desc,metadata.repositoryMetadata.repo:createDate asc",
- "limit": 50
}
{- "hits": {
- "results": [
- {
- "assetId": "urn:aaid:aem:9d68909d-378b-4c18-8b9d-0ep0g826e984",
- "repositoryMetadata": {
- "repo:name": "blue shoe.jpeg",
- "dc:format": "image/webp",
- "repo:createDate": "2023-05-29T12:54:36.410Z",
- "repo:modifyDate": "2023-05-11T14:12:09.304Z",
- "repo:size": 434292,
- "repo:repositoryId": "urn:rid:aem:65214-138691"
}, - "assetMetadata": {
- "xcm:machineKeywords": [
- {
- "localeCode": "en-US",
- "confidence": 0.7371780872344971,
- "value": "shoe"
}, - {
- "localeCode": "en-US",
- "confidence": 0.7185167074203491,
- "value": "wearable"
}
], - "tiff:ImageLength": 1800,
- "tiff:ImageWidth": 2400
}
}, - {
- "//other 8 asset metadata": null
}
]
}, - "cursor": "[\"45600323\",1478539971]",
- "search_metadata": {
- "count": 50,
- "totalCount": {
- "total": 92,
- "relation": "eq"
}, - "searchDuration": 16
}
}
Create short-lived token with access restrictions for searching assets and performing operations on specified indexes.
The API returns a token along with its validity.
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "indexes": [
- "assets",
- "collections"
], - "operationType": "search"
}
{- "token": "YTgyMzMwOTkzMjA2Mzk5OWUxNjhjYmIwMGZkNGFmMzk2NDU3ZjMyYTg1NThiZjgx",
- "expiryTime": "2024-02-28T21:39:02.417-0800",
- "appId": "5HEOA9BAT1"
}
Returns headers, including an ETag for the specified asset metadata, which can be a lighter method of checking for the existence of, or validating a cached version of an asset's metadata without sending a full GET request.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Asset metadata contains those metadata values that have been extracted from the asset, configured by the user, or derived from the asset during asset processing. Repository metadata contains metadata properties that are set and maintained by the repository during system operations.
If-None-Match | string The For more details, please head over to RFC9110. |
Metadata for the specified asset
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "value": {
- "assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
- "assetMetadata": {
- "xcm:keywords": [
- {
- "value": "Asset Properties : Orientation / Square",
- "@lang": "ENGLISH",
- "repo:ancestors": [
- "properties",
- "orientation",
- "square"
]
}
], - "xcm:machineKeywords": [
- {
- "value": "city",
- "confidence": 0.8512217998504639,
- "localeCode": "en-US"
}
], - "dc:creator": [
- "Photo Author"
], - "dc:description": "This is a view of a city skyline reflected in a body of water",
- "dc:title": "City skyline",
- "exif:GPSLatitude": "43,19.11N",
- "exif:GPSLongitude": "11,19.84E",
- "photoshop:ColorMode": 3,
- "photoshop:DateCreated": "2017-10-24T12:28:31.672Z",
- "tiff:BitsPerSample": [
- 8,
- 8,
- 8
], - "tiff:Orientation": 1,
- "xmp:CreateDate": "2016-08-09T00:00:00.000Z",
- "xmp:CreatorTool": "Adobe Photoshop CC 2019 (Macintosh)",
- "xmp:ModifyDate": "2019-11-21T22:02:22.000Z"
}, - "repositoryMetadata": {
- "aem:assetState": "processed",
- "aem:checkedOutBy": "testuser@test.com",
- "dam:sha1": "8601cc48d27d85ae274c954286edfde34b907e12",
- "dc:format": "image/jpeg",
- "repo:createDate": "2023-04-14T06:31:07.174Z",
- "repo:createdBy": "user@adobe.com",
- "repo:modifiedBy": "dam-writer-service",
- "repo:modifyDate": "2023-04-15T05:01:44.229Z",
- "repo:name": "city.jpeg",
- "repo:size": 338049,
- "repo:version": "oak:1.0::ci:y7ngaf96th56jt62awk8xkoa37c572fe",
- "tiff:imageLength": 780,
- "tiff:imageWidth": 1000,
- "repo:repositoryId": "author-p12345-e123456.adobeaemcloud.com",
- "repo:ancestors": [
- "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456"
], - "repo:state": "ACTIVE",
- "aem:published": "2023-04-22T23:26:09.036Z"
}
}
}
The Delivery API accepts an assetId, and if the ID corresponds to a video asset, delivers Player for video streaming. The asset ID is an opaque string defined by the content repository. The entity composing the Delivery URLs must know them apriori.
Response Video in Player.
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The Delivery API accepts an asset ID, and if the ID corresponds to a video asset, delivers the playback manifest in the requested protocol. The asset ID is an opaque string defined by the content repository. The entity composing the Delivery URLs must know them apriori. If the asset is not a video asset, client gets a 404 response.
Response Video Manifests in selected format
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
The List Image Presets API returns the image presets configured for the given tenant. A successful response includes a list of available image presets and their attributes.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-None-Match | string The For more details, please head over to RFC9110. |
List of available image presets
Not Modified
Unauthorized
Forbidden
{- "cursor": "123",
- "items": [
- {
- "name": "testImagePreset1",
- "format": "jpeg"
}, - {
- "name": "testImagePreset2",
- "format": "jpeg,gray"
}
]
}
Creates a collection that represents a group of Asset(s) and/or Collection(s).
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Returns information on the recently created collection, including its metadata.
Accepted
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
{- "title": "Product Images",
- "description": "Images approved for use in the product catalog",
- "items": [
- {
- "id": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "type": "asset"
}
]
}
{- "id": "urn:cid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repositoryMetadata": {
- "repo:repositoryId": "author-p12345-e12345.adobeaemcloud.com",
- "repo:createDate": "2019-08-24T14:15:22Z",
- "repo:createdBy": "string",
- "repo:modifiedBy": "string",
- "repo:modifyDate": "2019-08-24T14:15:22Z"
}, - "collectionMetadata": {
- "title": "Product Images",
- "description": "Images approved for use in the product catalog"
}
}
Retrieves all the Collections available in the repository.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Collections retrieved successfully
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
{- "cursor": "string",
- "items": [
- {
- "id": "urn:cid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repositoryMetadata": {
- "repo:repositoryId": "author-p12345-e12345.adobeaemcloud.com",
- "repo:createDate": "2019-08-24T14:15:22Z",
- "repo:createdBy": "string",
- "repo:modifiedBy": "string",
- "repo:modifyDate": "2019-08-24T14:15:22Z"
}, - "collectionMetadata": {
- "title": "Product Images",
- "description": "Images approved for use in the product catalog"
}
}
]
}
Retrieves collection metadata for a given collection id along with Etag representing the current state of the collection.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-None-Match | string The For more details, please head over to RFC9110. |
X-Adobe-Accept-Experimental required | integer Value: 1 |
Collection Metadata Retrieved successfully
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "id": "urn:cid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repositoryMetadata": {
- "repo:repositoryId": "author-p12345-e12345.adobeaemcloud.com",
- "repo:createDate": "2019-08-24T14:15:22Z",
- "repo:createdBy": "string",
- "repo:modifiedBy": "string",
- "repo:modifyDate": "2019-08-24T14:15:22Z"
}, - "collectionMetadata": {
- "title": "Product Images",
- "description": "Images approved for use in the product catalog"
}
}
Returns headers, including an ETag for the specified collection, which can be a lighter method of checking for the existence of, or validating a cached version of an collection without sending a full GET request.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Deletes a collection for a given collection id. If the delete operation requires more than a few seconds to complete, a status link with the jobId is returned in the response header that can be used to check the status.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-Match required | string The For more details, please head over to RFC9110. |
Accepted
Collection deleted successfully.
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
Precondition Failed
Precondition Required
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Updates the metadata for a given collection id.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-Match required | string The For more details, please head over to RFC9110. |
No Content
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
Precondition Failed
Precondition Required
{- "title": "New Title",
- "description": "New Description"
}
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Retrieve a paginated list of the items in the specified collection.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-None-Match | string The For more details, please head over to RFC9110. |
X-Adobe-Accept-Experimental required | integer Value: 1 |
Collection Retrieved successfully
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "cursor": "string",
- "self": [
- {
- "id": "urn:cid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repositoryMetadata": {
- "repo:repositoryId": "author-p12345-e12345.adobeaemcloud.com",
- "repo:createDate": "2019-08-24T14:15:22Z",
- "repo:createdBy": "string",
- "repo:modifiedBy": "string",
- "repo:modifyDate": "2019-08-24T14:15:22Z"
}, - "collectionMetadata": {
- "title": "Product Images",
- "description": "Images approved for use in the product catalog"
}
}
], - "items": [
- {
- "id": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "repo:repositoryId": "author-p12345-e12345.adobeaemcloud.com",
- "type": "asset"
}
]
}
Returns headers, including an ETag for the specified assets collection, which can be a lighter method of checking for the existence of, or validating a cached version of an collection without sending a full GET request.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
If the update operation requires more than a few seconds to complete, response includes a Location
header which contains the URL to poll for status of this operation.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
If-Match required | string The For more details, please head over to RFC9110. |
Adds or removes an item from the collection.
Accepted
No Content
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
Precondition Failed
Precondition Required
[- {
- "op": "remove",
- "id": "urn:aaid:aem:fc472a53-4ef1-4fdb-8ebb-f9b1ee75985w",
- "type": "asset"
}, - {
- "op": "add",
- "id": "urn:aaid:aem:fc472a53-4ef1-4fdb-8ebb-f9b1ee75985w",
- "type": "asset"
}
]
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Retrieves the current job's status for a collection.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Status of a task being processed
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
{- "operation": "aem.assets.collections.deleteCollection",
- "status": 200,
- "description": "Collection deleted successfully",
- "data": {
- "id": "12a020e8-ca19-44aa-91fa-c1c0db97edff",
- "collectionId": "urn:cid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "status": "COMPLETED"
}, - "errors": [ ],
- "warnings": [
- {
- "title": "Not Found",
- "detail": "Asset 'xyz-123' could not be found"
}
]
}
This endpoint allows users to create new link for given assets or collections, with the provided details.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Returns shareable links for the requested assets or collections, along with link metadata
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "assets": [
- {
- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75"
}
], - "title": "Sample link",
- "description": "Sample link description",
- "access": "public",
- "expiryTime": "2021-05-20T20:00:00.000Z"
}
{- "id": "6ba7b8109dad11d180b40002a5d5c51b62xsa4uT0qO_hvyym329pOYFasfPffVM9E-IPgs9KM",
- "title": "Sample link",
- "access": "public",
- "sharedItemsCount": 1,
- "expiryTime": "2021-05-20T20:00:00.000Z",
- "createdDate": "2021-05-15T10:30:00.000Z",
- "owner": "user@adobe.com"
}
Retrieves a list of non-expired shared links.
This endpoint allows users to retrieve a list of shared links that are currently non-expired and accessible.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Response list of non-expired shared links
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "links": [
- {
- "id": "6ba7b8109dad11d180b40002a5d5c51b62xsa4uT0qO_hvyym329pOYFasfPffVM9E-IPgs9KM",
- "title": "Sample link",
- "access": "public",
- "sharedItemsCount": 1,
- "expiryTime": "2021-05-20T20:00:00.000Z",
- "createdDate": "2021-05-15T10:30:00.000Z",
- "owner": "user@adobe.com"
}
]
}
Get detailed information about a shared link, including associated assets or collections URLs.
This endpoint allows users to fetch information about a specific shared link by providing its unique identifier.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Response of shared link containing shared assets or collections
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "assets": [
- {
- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "token": "T0lUJUypSG06pJabw3guL6kNRfz6S3wP6nA2gRlXERI",
- "expiryTime": "2021-05-20T20:00:00.000Z"
}
], - "id": "6ba7b8109dad11d180b40002a5d5c51b62xsa4uT0qO_hvyym329pOYFasfPffVM9E-IPgs9KM",
- "title": "Sample link",
- "access": "public",
- "sharedItemsCount": 1,
- "expiryTime": "2021-05-20T20:00:00.000Z",
- "createdDate": "2021-05-15T10:30:00.000Z",
- "owner": "user@adobe.com"
}
This endpoint allows users to delete a shared link by providing its unique identifier.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Link deleted successfully.
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Event triggered when an asset can no longer be rendered through new DM APIs. This is used by applications when processing of asset(s) in delivery tier takes a long time, for example, video assets or assets going through any ML pipeline.
id required | string non-empty An identifier for the event. When used in combination with the |
source required | string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the
producer of this event, of the format |
specversion required | string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. |
type required | string >= 4 characters ^aem\..*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. |
datacontenttype required | string non-empty The format of the data in the event. This will always be |
dataschema | string <uri> An optional attribute, which may point to a JSON schema document that covers the data object. |
time required | string <date-time> non-empty A timestamp of when the event occurred. |
required | object The event payload. |
Asset delivery disabled event data is received successfully
{- "specversion": "1.0",
- "type": "aem.assets.asset.removed_from_delivery",
- "source": "acct:aem-p56789-e12345@adobe.com",
- "id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
- "time": "2018-04-05T17:31:00Z",
- "datacontenttype": "application/json",
- "data": {
- "myProp": "myValue",
- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75"
}
}
Event triggered when an asset is ready for delivery through new DM APIs. This is used by applications when processing of asset(s) in delivery tier takes a long time, for example, video assets or assets going through any ML pipeline.
id required | string non-empty An identifier for the event. When used in combination with the |
source required | string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the
producer of this event, of the format |
specversion required | string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. |
type required | string >= 4 characters ^aem\..*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. |
datacontenttype required | string non-empty The format of the data in the event. This will always be |
dataschema | string <uri> An optional attribute, which may point to a JSON schema document that covers the data object. |
time required | string <date-time> non-empty A timestamp of when the event occurred. |
required | object The event payload. |
Asset delivery ready event data is received successfully
{- "specversion": "1.0",
- "type": "aem.assets.asset.ready_for_delivery",
- "source": "acct:aem-p56789-e12345@adobe.com",
- "id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
- "time": "2018-04-05T17:31:00Z",
- "datacontenttype": "application/json",
- "data": {
- "myProp": "myValue",
- "value": {
- "assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
- "assetMetadata": {
- "xcm:machineKeywords": [
- {
- "value": "city",
- "confidence": 0.8512217998504639,
- "localeCode": "en-US"
}
], - "pur:expirationDate": "2023-04-17T06:31:07.174Z"
}, - "repositoryMetadata": {
- "aem:assetState": "processed",
- "aem:checkedOutBy": "testuser@test.com",
- "dam:sha1": "8601cc48d27d85ae274c954286edfde34b907e12",
- "dc:format": "image/jpeg",
- "repo:createDate": "2023-04-14T06:31:07.174Z",
- "repo:createdBy": "user@adobe.com",
- "repo:modifiedBy": "dam-writer-service",
- "repo:modifyDate": "2023-04-15T05:01:44.229Z",
- "repo:name": "city.jpeg",
- "repo:size": 338049,
- "repo:version": "oak:1.0::ci:y7ngaf96th56jt62awk8xkoa37c572fe",
- "tiff:imageLength": 780,
- "tiff:imageWidth": 1000,
- "repo:repositoryId": "author-p12345-e123456.adobeaemcloud.com",
- "repo:ancestors": [
- "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456"
], - "repo:state": "ACTIVE",
- "aem:published": "2023-04-22T23:26:09.036Z"
}
}
}
}
APIs for generating archives containing binaries (one or more assets, with one or more renditions) in one of the supported archival formats (e.g., zip
).
Request creation of an archive for the asset references specified in the request payload. The response contains an identifier and metadata pertaining to the archive request.
The result of the operation will be one or more archives. The API may use various factors to determine the number of archives required to complete the operation. For example, very large archive request might be split into multiple files.
Consumers of this API should use the response Location
header to poll for the status of the archive creation request. The polling interval should be determined by the Retry-After
header value.
Invalid assets specified for inclusion in the archive will not fail the overall creation process. Instead, the API will create a archive containing the assets it could find, with invalid asset references appearing as warnings in the final status response.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
required | Array of objects non-empty Assets to be included in the archive. By default, any custom renditions generated via Processing Profiles and original rendition are included, and all others are excluded. The request can optionally specify renditions that MUST be included-in or excluded-from the archive being requested. |
format | string (ArchiveFormat) Default: "zip" The output format of the archive |
namePrefix | string The name to use for the created archive file(s). Note that the API will treat this as a suggestion, and reserves the right to change the final archive name as needed. If not provided, the API will assign its own file name according to any logic it deems fit. |
Accepted
Bad Request. The Problem Details object will provide more information about the exact cause.
Unauthorized
Forbidden
Unsupported Media Type. When provided as a response to a PATCH
request,
the response will provide an Accept-Patch
response header to notify
the client what patch document media types are supported.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "items": [
- {
- "assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
- "includeRenditions": [
- "thumbnail.319.png",
- "customRenditionName.png"
], - "excludeRenditions": [
- "original"
]
}
], - "format": "zip",
- "namePrefix": "assets"
}
{- "id": "1a034bee-ebda-4787-bad3-f924d0772b75",
- "format": "zip",
- "submittedBy": "person@company.com",
- "submittedDate": "2024-02-28T21:39:02.417-0800"
}
Get the status of the archive creation request
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Ok
Unauthorized
Forbidden
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "operation": "aem.assets.archives.createArchive",
- "status": 200,
- "description": "Archive created successfully",
- "data": {
- "id": "12a020e8-ca19-44aa-91fa-c1c0db97edff",
- "format": "zip",
- "submittedBy": "person@company.com",
- "submittedDate": "2024-02-28T21:39:02.417-0800",
- "status": "COMPLETED",
- "completionDate": "2024-02-28T21:50:31.346-0800",
}, - "errors": [ ],
- "warnings": [
- {
- "title": "Not Found",
- "detail": "Asset 'xyz-123' could not be found"
}
]
}
For a given archiveId
, one or more archive files can be created.
Archival Request Status API provides the list of archive files available for the archiveId
. This API enables download of any/all of those files.
NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn’t covered in Adobe Support agreements.
Found
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Not Found",
- "status": 404,
- "detail": "The requested resource could not be found."
}