Assets Author API (2026.04-experimental)

Download OpenAPI specification:Download

API definitions for asset management capabilities in AEM Assets. To configure a client to access to these APIs, visit the Adobe Developer Console and add the "AEM Assets Author API" card to your project.

Assets

APIs for working with assets

Get an asset

Returns an existing web-optimized binary representation of the asset.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId

required

string (AssetId) non-empty

ID of the asset

Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Web-optimized version of the asset

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/{assetId}

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Delete asset

Deletes an existing asset from the system. In most cases, a 204 response will be returned immediately, but in some cases, a 202 will be returned if the operation may take a long time to complete. This most commonly occurs when an asset has a large number of references to update, but can occur for other reasons as well.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId

required

string (AssetId) non-empty

ID of the asset

Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

query Parameters

force

boolean

If true, delete the asset even if it is referenced

Responses

202

Accepted

204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

delete/{assetId}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"jobId": "85f7c90a-a252-4e82-8cf3-3c989829cdf9",
"state": "PROCESSING"
}

Search for assets based on specified criteria

Search Assets in author environment

SecurityBearer

Request

query Parameters

allowUnsafeSearch

required

boolean

Enables searching against properties that are not indexed. This parameter is currently required and must be set to true for all search requests, as we have not yet implemented validating that properties passed in search request are indexed. Not doing so will make the server reply with a 400 response.

In the future, if we implement such a feature, this parameter will become optional and will default to false. This property being present and set to true will allow existing requests to continue to be processed in a backward-compatible manner at that time.

Request Body schema:
application/json
required

Use application/json for text-only searches. Use multipart/form-data when uploading a PDF file for enhanced search.

required	Array of OrQuery (object) or AndQuery (object) or NotQuery (object) or MatchQuery (object) or TermQuery (object) or RangeQuery (object) or ExistsQuery (object) (CompositeQuery) [ 1 .. 5 ] items List of `CompositeQuery` elements. The elements in this list will be applied using an AND logic. Property field names used in the queries must follow the schema structure of the metadata returned in this API response. Examples of valid field references: `repositoryMetadata.repo:name` - Asset filename `assetMetadata.dc:title` - Asset title
	Array of objects The `sort` parameter defines how search results are ordered. It accepts a list of objects, each specifying a field to sort by and an optional sort order. The order can be `ASC` (ascending) or `DESC` (descending). If no order is provided, ascending (`ASC`) is used by default. Sorting is applied in sequence - results are first sorted by the field in the first object. If multiple items share the same value, the next object in the list is used, and so on. This allows for multi-level sorting of results. If no `sort` parameter is provided, results will be ordered by relevance to the search query.
limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty A cursor is an opaque string that can be used in API calls which support paginating the response. A non-existent cursor signifies that the returned list does not have more elements.
	object (ProjectedFields) Specifies which fields to include or exclude in the search results. Use 'includes' to return only specific fields, or 'excludes' to omit specific fields. If both are specified, 'includes' takes precedence. Note: The asset ID is always included in the response regardless of the projected fields configuration, to ensure results can be properly differentiated.
	Array of objects (FacetRequest) <= 2 items Facet requests for dc:format and dam:assetStatus metadata fields

Responses

200

Asset Search Response

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

413

Content Too Large. Indicates that the server is refusing to process a request because the request content is larger than the server is willing or able to process.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

501

Not Implemented. Indicates that the server does not support the functionality required to fulfill the request.

post/search

Request samples

Payload
curl
Java
Node.js
JavaScript

{"query": [{"and": [{"or": [{"match": {"text": "blue",
"mode": "FULLTEXT",
"fields": ["repositoryMetadata.repo:name"
]
}
},
{"match": {"text": "red",
"mode": "FULLTEXT",
"fields": ["repositoryMetadata.repo:name"
]
}
},
{"match": {"text": "assets with file names containing 'green'",
"mode": "HYBRID"
}
}
]
},
{"not": [{"term": {"repositoryMetadata.dc:format": ["video/mp4"
]
}
}
]
}
]
},
{"range": {"repositoryMetadata.repo:size": {"gte": 3000000,
"lte": 9000000
}
}
},
{"term": {"assetMetadata.xcm:keywords.tagId": ["f47ac10b-58cc-4372-a567-0e02b2c3d479"
]
}
}
],
"sort": [{"field": "repositoryMetadata.repo:size",
"order": "DESC"
},
{"field": "repositoryMetadata.repo:createDate",
"order": "ASC"
}
],
"limit": 3,
"facets": [{"type": "CATEGORY",
"field": "repositoryMetadata.dc:format",
"id": "file_format",
"size": 100
},
{"type": "CATEGORY",
"field": "assetMetadata.dam:assetStatus",
"id": "dam_status",
"size": 25
}
],
"projectedFields": {"includes": ["metadata.assetMetadata.dc:title",
"metadata.assetMetadata.dc:creator",
"metadata.repositoryMetadata.repo:createDate"
]
}
}

Response samples

application/json

{"hits": {"results": [{"assetId": "urn:aaid:aem:9d68909d-378b-4c18-8b9d-0ep0g826e984",
"repositoryMetadata": {"repo:name": "blue-shoe.jpg",
"dc:format": "image/jpeg",
"repo:createDate": "2023-05-29T12:54:36.410Z",
"repo:modifyDate": "2023-05-11T14:12:09.304Z",
"repo:size": 434292,
"repo:repositoryId": "author-p12345-e123456.adobeaemcloud.com"
},
"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
}
},
{"assetId": "urn:aaid:aem:4e72f5bc-198a-4f92-a7d1-95f3ab428c61",
"repositoryMetadata": {"repo:name": "red-shoe.jpg",
"dc:format": "image/jpeg",
"repo:createDate": "2023-06-15T09:23:18.720Z",
"repo:modifyDate": "2023-06-16T11:08:42.115Z",
"repo:size": 1258764,
"repo:repositoryId": "author-p12345-e123456.adobeaemcloud.com"
},
"assetMetadata": {"xcm:machineKeywords": [{"localeCode": "en-US",
"confidence": 0.892456130978523,
"value": "mountain"
},
{"localeCode": "en-US",
"confidence": 0.8156347289106783,
"value": "landscape"
},
{"localeCode": "en-US",
"confidence": 0.7392815674392018,
"value": "nature"
}
],
"tiff:ImageLength": 3000,
"tiff:ImageWidth": 4500
}
},
{"assetId": "urn:aaid:aem:2b39c41d-8954-401e-b7a3-72e5f9c26ab2",
"repositoryMetadata": {"repo:name": "green-shoe.png",
"dc:format": "image/png",
"repo:createDate": "2023-07-08T14:37:52.196Z",
"repo:modifyDate": "2023-07-10T08:45:29.831Z",
"repo:size": 3842156,
"repo:repositoryId": "author-p12345-e123456.adobeaemcloud.com"
},
"assetMetadata": {"xcm:machineKeywords": [{"localeCode": "en-US",
"confidence": 0.892456130978523,
"value": "product"
},
{"localeCode": "en-US",
"confidence": 0.8156347289106783,
"value": "brochure"
}
],
"tiff:ImageLength": 1900,
"tiff:ImageWidth": 2500
}
}
]
},
"cursor": "opaque-string",
"facets": [{"type": "CATEGORY",
"field": "repositoryMetadata.dc:format",
"id": "file_format",
"values": [{"value": "image/jpeg",
"count": 50
},
{"value": "image/png",
"count": 30
},
{"value": "video/mp4",
"count": 20
}
]
},
{"type": "CATEGORY",
"field": "assetMetadata.dam:assetStatus",
"id": "dam_status",
"values": [{"value": "approved",
"count": 20
},
{"value": "rejected",
"count": 5
}
]
}
]
}

Returns the originally uploaded binary for the asset

The Original Asset Author 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.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId required	string (AssetId) non-empty ID of the asset Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
seoName required	string([%.\w-]+) any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots Examples: seo-name banner

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Original binary of the asset

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/{assetId}/original/as/{seoName}

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Returns a list of static renditions of an asset

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. Note that only renditions that support dimensions will return dimension values, otherwise the dimensions will be null.

SecurityBearer or ApiKeyAuth

Request

path Parameters

assetId

required

string (AssetId) non-empty

ID of the asset

Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

List of available renditions

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/{assetId}/renditions

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"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 a pre-generated (on AEM Assets authoring environment) rendition of the asset

The Asset Rendition Author 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).

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId required	string (AssetId) non-empty ID of the asset Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
renditionName required	string([%.\w-]+) any url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots Examples: seo-name banner
seoName required	string([%.\w-]+) any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots Examples: seo-name banner

query Parameters

attachment

string

Setting this parameter to true forces "download" prompt in browser by adapting the Content-Disposition appropriately.

Default is false.

Enum: "true" "1" "false" "0"

Example: attachment=true

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Binary of the specified rendition for the selected asset

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/{assetId}/renditions/{renditionName}/as/{seoName}

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Events

Events generated by AEM Assets

Asset processing completed eventWebhook

Event triggered when an asset has completed processing in AEM. This is often used in place of an 'asset created' event for use cases that trigger from asset creation for two reasons - many extensions require some amount of asset metadata, which is extracted during asset processing and acting upon an asset that is in processing has a high chance of running into conflicts and contention issues.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.processing_completed"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset processing completed event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.processing_completed",
"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:path": "/content/dam/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"
}
}
}
}

Asset deleted eventWebhook

An event that is triggered when an asset is deleted from AEM through the Assets View UI or the Assets Open API. It is not triggered when the asset is deleted with the AEM Touch UI or other AEM APIs.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.deleted"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset deleted event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.deleted",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "4fd1cdd8-0898-4d60-90ad-3d442517d3cb",
"time": "2021-05-20T20:00:00.000Z",
"datacontenttype": "application/json",
"data": {"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"user": {"imsUserId": "11362B9E62F4CD400A495ECF@09f51d11618ca7b4495ee0.e",
"principalId": "testuser@adobe.com",
"displayName": "Test User"
},
"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:path": "/content/dam/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-15T05:03:47.229Z",
"repo:assetClass": "file"
},
"assetMetadata": {"xcm:machineKeywords": [{"value": "graphic design",
"confidence": 0.926
},
{"value": "clipart",
"confidence": 0.757
}
],
"pur:expirationDate": "2023-04-17T06:31:07.174Z"
}
}
}

Asset downloaded eventWebhook

Event triggered when an asset, folder or collection of assets is downloaded from AEM.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.downloaded"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset downloaded event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.downloaded",
"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",
"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
"assetMetadata": {"xcm:machineKeywords": [{"value": "graphic design",
"confidence": 0.926
},
{"value": "clipart",
"confidence": 0.757
}
],
"pur:expirationDate": "2023-04-17T06:31:07.174Z",
"dc:title": "Asset name"
},
"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:path": "/content/dam/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",
"repo:assetClass": "file"
},
"downloadedRenditions": [{"name": "2023-lexus-rx-450hl.jpg",
"format": "image/jpeg",
"size": 1,
"dimensions": {"width": 1,
"height": 1
}
}
]
}
}

Asset metadata updated eventWebhook

Event triggered when an asset has had its metadata updated through the Assets View UI or the Assets Open API. It is not triggered when metadata is updated with the AEM Touch UI or other AEM APIs.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.metadata_updated"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset metadata updated event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.metadata_updated",
"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",
"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
"assetMetadata": {"addedProp": "addedValue",
"dc:description": "The updated description.",
"event:created": ["addedProp"
],
"event:updated": {"dc:description": "The previous description before the update."
},
"event:deleted": {"removedProp": "removedValue"
},
"xcm:machineKeywords": [{"value": "city",
"confidence": 0.8512217998504639
}
],
"pur:expirationDate": "2023-04-17T06:31:07.174Z",
"dc:title": "Asset name"
},
"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:path": "/content/dam/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",
"repo:assetClass": "file"
}
}
}

Asset published eventWebhook

This event is triggered when an asset is published from an author instance to a publish instance. This event will be sent whenever an asset is published directly. Additionally, if an asset is moved using the Assets View UI or the OpenAPI, an asset unpublished event will be sent, followed by an asset published event. We do not support this behavior when assets are moved from the Admin View UI (aka Touch UI) or from other APIs, such as Java APIs running in-process in the AEM environment.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.published"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset published event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.published",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "4fd1cdd8-0898-4d60-90ad-3d442517d3cb",
"time": "2021-05-20T20:00:00.000Z",
"datacontenttype": "application/json",
"data": {"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"user": {"imsUserId": "11362B9E62F4CD400A495ECF@09f51d11618ca7b4495ee0.e",
"principalId": "testuser@adobe.com",
"displayName": "Test User"
},
"tier": "publish",
"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:path": "/content/dam/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-15T05:03:47.229Z",
"repo:assetClass": "file"
},
"assetMetadata": {"xcm:machineKeywords": [{"value": "graphic design",
"confidence": 0.926
},
{"value": "clipart",
"confidence": 0.757
}
],
"pur:expirationDate": "2023-04-17T06:31:07.174Z"
}
}
}

Asset unpublished eventWebhook

An event that is triggered when an asset is unpublished from an AEM publish instance. This event will be sent whenever an asset is unpublished directly. Additionally, if an asset is moved or deleted using the Assets View UI or the OpenAPI, an asset unpublished event will be sent. We do not support this behavior when assets are moved or deleted from the Admin View UI (aka Touch UI) or from other APIs, such as Java APIs running in-process in the AEM environment.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.asset.unpublished"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset unpublished event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.asset.unpublished",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "4fd1cdd8-0898-4d60-90ad-3d442517d3cb",
"time": "2021-05-20T20:00:00.000Z",
"datacontenttype": "application/json",
"data": {"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"user": {"imsUserId": "11362B9E62F4CD400A495ECF@09f51d11618ca7b4495ee0.e",
"principalId": "testuser@adobe.com",
"displayName": "Test User"
},
"tier": "publish",
"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:path": "/content/dam/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-15T05:03:47.229Z",
"repo:assetClass": "file"
},
"assetMetadata": {"xcm:machineKeywords": [{"value": "graphic design",
"confidence": 0.926
},
{"value": "clipart",
"confidence": 0.757
}
],
"pur:expirationDate": "2023-04-17T06:31:07.174Z"
}
}
}

Asset import completed eventWebhook

Event triggered when an asset import operation is completed in AEM.

SecurityNone

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
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 `acct:aem-p<programId>-e<environmentId>@adobe.com`.
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. Value: "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. Value: "aem.assets.import.completed"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
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.

Responses

200

Asset import completed event data is received successfully

Request samples

Payload

application/json

{"specversion": "1.0",
"type": "aem.assets.import.completed",
"source": "acct:aem-p12345-e12345@adobe.com",
"id": "ffa69f14-4f78-11ed-bdc3-0242ac129992",
"time": "2024-08-12T15:29:00Z",
"datacontenttype": "application/json",
"data": {"jobId": "45a44ed7-f823-4a4c-896c-02b340ee87f0",
"startTime": "2025-01-01T00:00:00Z",
"endTime": "2025-01-01T00:01:00.11Z",
"operation": "aem.assets.import.fromurl",
"status": "completed",
"resultEndpoint": "https://author-p12345-e12345.adobeaemcloud.com/adobe/assets/import/jobs/45a44ed7-f823-4a4c-896c-02b340ee87f0/result"
}
}

Metadata

APIs for working with asset metadata

Head request for asset metadata

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.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

head/{assetId}/metadata

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Delivers the specified asset's metadata

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.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Metadata for the specified asset

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/{assetId}/metadata

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"value": {"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"assetMetadata": {"xcm:keywords": [{"tagId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"ancestorIds": ["6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"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:path": "/content/dam/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"
}
}
}

Updates the asset's assetMetadata properties

The specified properties will be updated per the RFC-6902 syntax. Note that while assetMetadata is editable, repositoryMetadata is not. If repositoryMetadata is specified in the request, a 400 response will be returned.

SecurityBearer and ApiKeyAuth

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

header Parameters

If-Match

required

string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json-patch+json

Array

op required	string The operation to perform add
path required	string non-empty The location where information should be added
required	string or number or Array of any or object or boolean (PatchValue) The information to place at the location indicated by the `path` parameter

Responses

200

Patch applied

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

409

Conflict. Indicates that the request could not be completed due to a conflict with the current state of the target resource.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

patch/{assetId}/metadata

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json-patch+json

[{"op": "test",
"path": "/dc:title",
"value": "old value"
},
{"op": "replace",
"path": "/dc:title",
"value": "new value"
},
{"op": "copy",
"from": "/dc:title",
"path": "/custom:title"
}
]

Response samples

application/json

{"value": {"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"assetMetadata": {"xcm:keywords": [{"tagId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"ancestorIds": ["6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"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:path": "/content/dam/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"
}
}
}

Relations

APIs for working with asset relations

Get the asset relations for an asset

Get a paginated list of all relations for an asset, optionally filtered by relation types. If the relationTypes parameter is provided, only relations for the provided type name(s) will be returned. By default, the response will contain a maximum of 50 items per page. The caller may pass the limit query parameter to override this default with a lower limit. To request the next page of items, pass the cursor value provided in the response to the cursor query parameter.

SecurityBearer

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

query Parameters

limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
relationTypes	Array of strings unique Comma-delimited list of relation types to filter the asset relations to include only the specified types. Example: relationTypes=sources,derived,others

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Paginated list of relations for the given asset or an empty list if the asset has no relations.

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/{assetId}/relations

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"relationType": "sources",
"repo:path": "/content/dam/test/document.pdf",
"repo:name": "document.pdf"
},
{"assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
"relationType": "derived",
"repo:path": "/content/dam/test/image.png",
"repo:name": "image.png"
}
],
"cursor": "wqeaszrdxtgfcyguiohfgytdrsewq"
}

Create new asset relations for an asset

Create new asset relations for the given asset. Each asset relation object in the request must include the ID of the related asset and the relation type.

SecurityBearer

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

Request Body schema: application/json
required

required

Array of objects unique

Related assets to be added to the asset

Responses

204

Asset relations created successfully.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/{assetId}/relations

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"items": [{"assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
"relationType": "sources"
}
]
}

Response samples

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Get the asset relations for an asset filtered by relation type

Get a paginated list of relations for an asset filtered by a relation type. Only relations for the provided type name will be returned. By default, the response will contain a maximum of 50 items per page. The caller may pass the limit query parameter to override this default with a lower limit. To request the next page of items, pass the cursor value provided in the response to the cursor query parameter.

SecurityBearer

Request

path Parameters

assetId required	string non-empty ID of the asset to access Examples: sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
relationType required	string Name of relation type

query Parameters

limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Paginated list of relations for the given asset and relation type or an empty list if the asset has no relations for the relation type.

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/{assetId}/relations/{relationType}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"assetId": "urn:aaid:aem:abcd1234-ab12-ab12-ab12-abcdef123456",
"relationType": "sources",
"repo:path": "/content/dam/test/document.pdf",
"repo:name": "document.pdf"
},
{"assetId": "urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75",
"relationType": "derived",
"repo:path": "/content/dam/test/image.png",
"repo:name": "image.png"
}
],
"cursor": "wqeaszrdxtgfcyguiohfgytdrsewq"
}

Delete all asset relations of the given relation type for an asset

Delete all asset relations of type relationType for the asset corresponding to the given assetId parameter.

SecurityBearer

Request

path Parameters

assetId required	string non-empty ID of the asset to access Examples: sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
relationType required	string Name of relation type

Responses

204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/{assetId}/relations/{relationType}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Delete an asset relation for an asset

Delete an asset relation for the asset corresponding to the given assetId parameter. The relationType and relatedAssetId parameters must correspond to values from an existing asset relation returned by the getAssetRelations operation for the asset.

SecurityBearer

Request

path Parameters

assetId required	string non-empty ID of the asset to access Examples: sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
relationType required	string Name of relation type for asset relation to be deleted.
relatedAssetId required	string (AssetId) non-empty ID of the related asset to be deleted. Example: urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

Responses

204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/{assetId}/relations/{relationType}/{relatedAssetId}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Get the relation types for an asset

Get a paginated list of relation type names that exist for the given asset. The values returned in this response can be used in the relationTypes parameter for the getAssetRelations operation. By default, the response will contain a maximum of 50 items per page. The caller may pass the limit query parameter to override this default with a lower limit. To request the next page of items, pass the cursor value provided in the response to the cursor query parameter.

SecurityBearer

Request

path Parameters

assetId

required

string non-empty

ID of the asset to access

Examples:

sample-asset-id urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75

query Parameters

limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

Paginated list of relation type names for the given asset or an empty list if the asset has no relations.

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/{assetId}/relationTypes

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": ["sources",
"derived",
"others"
],
"cursor": "wqeaszrdxtgfcyguiohfgytdrsewq"
}

Import

APIs for importing assets into AEM Assets

Import From Url

Imports the binary found at the specified URL into AEM as an Asset or as a Rendition of an existing Asset.

While we have successfully tested imports with file sizes up to 30GB from common cloud storage providers, your results may vary based on the throughput provided by the source from which the assets are being imported.

Requirements for Large Files (≥10GB)

Files 10GB and larger require:

HTTP Range request support from the source URL (RFC 7233, Section 3.1: Range Header Syntax)
Maintaining stable, high-throughput connection to avoid timeouts

Pre-Import Validation:

Our API will test your URL with this request before importing large files:

curl -H "Range: bytes=0-0" -I <your-url>

Required Response:

HTTP/1.1 206 Partial Content
Content-Range: bytes 0-0/[total-file-size]
Accept-Ranges: bytes

Without the required response, import will fail.

Common Implementation Examples:

Most cloud storage providers support Range requests by default:

AWS S3, Google Cloud Storage, Azure Blob Storage - RFC 7233 compliant

Technical Reference:

Full specification available at: RFC 7233 - HTTP/1.1 Range Requests

SecurityBearer and ApiKeyAuth

Request

Request Body schema: application/json
required

The request body for importing one or more Assets from a URL. The request body contains the metadata for the assets to be imported and the URLs and descriptive data for the URLs to import.

	object (ImportAssetMetadata) Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints.
folder required	string (ImportTargetFolder) non-empty The ID or path for the folder into which to import the assets in AEM.
required	Array of objects [ 1 .. 300 ] items
sourceName	string A user-friendly display name for the source of the assets

Responses

202

The response for an accepted import request. The path provided in the Location header can be followed to monitor the import's progress.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

post/import/fromUrl

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"assetMetadata": {"dc:title": "My Asset",
"xmp:Rating": 5,
"prism:expirationDate": "2019-01-01T00:00:00.000Z"
},
"folder": "urn:aaid:aem:8964ca64-b302-5abe-88db-e1729385287b",
"files": [{"fileName": "My-Asset.jpeg",
"assetMetadata": {"custom:test": "custom-metadata"
},
"mimeType": "image/jpeg",
"fileSize": 123456,
"url": "https://example.com/my-asset.jpg"
}
]
}

Response samples

application/json

{"id": "c82f6f05-07e3-5d13-b6bf-be0ac408fddf",
"operation": "aem.assets.import.fromurl",
"data": {"id": "c82f6f05-07e3-5d13-b6bf-be0ac408fddf",
"config": {"assetMetadata": {"dc:title": "My Asset",
"xmp:Rating": 5,
"prism:expirationDate": "2019-01-01T00:00:00.000Z"
},
"folder": "urn:aaid:aem:8964ca64-b302-5abe-88db-e1729385287b",
"items": ["https://example.com/my-asset.jpg"
]
},
"processedFiles": [ ],
"progress": {"imported": 0,
"failed": 0,
"skipped": 0,
"started": "2025-03-24T18:23:15.885Z",
"total": 2,
"lastUpdated": "2025-03-24T18:23:15.885Z",
"size": 0,
"transferred": 0,
"step": "QUEUED"
}
},
"errors": [ ],
"warnings": [ ],
"state": "PROCESSING"
}

Head request for import job status

Returns headers, including an ETag for the specified import job status, which can be used to check for the existence of, or validate a cached version of the import job status without sending a full GET request.

SecurityBearer and ApiKeyAuth

Request

path Parameters

importJobId

required

string (ImportJobId)

The identifier for an import job

Example: B79F5F05-06E2-4D12-A5AE-AD9BC308FCCF

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

head/import/jobs/{importJobId}/status

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Get Import Job Status

Retrieves the status of the specified import job. If the job is in progress, the response will have a status of 200 and include a Retry-After header with the number of seconds to wait before checking the status again. If the job is complete, the response will have a status of 200 and the response body will include the final status of the job.

SecurityBearer and ApiKeyAuth

Request

path Parameters

importJobId

required

string (ImportJobId)

The identifier for an import job

Example: B79F5F05-06E2-4D12-A5AE-AD9BC308FCCF

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

A response describing the status of an import job

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/import/jobs/{importJobId}/status

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"id": "B79F5F05-06E2-4D12-A5AE-AD9BC308FCCF",
"description": "OK",
"operation": "aem.assets.import.fromurl",
"status": 202,
"state": "PROCESSING",
"progress": {"imported": 1,
"failed": 1,
"skipped": 0,
"started": "2019-01-01T00:00:00.000Z",
"total": 2,
"lastUpdated": "2019-01-01T00:00:00.000Z",
"size": 123456,
"transferred": 2345,
"step": "IMPORTING"
},
"errors": [ ],
"warnings": [ ]
}

Head request for import job result

Returns headers, including an ETag for the specified import job result, which can be used to check for the existence of, or validate a cached version of the import job result without sending a full GET request.

SecurityBearer and ApiKeyAuth

Request

path Parameters

importJobId

required

string (ImportJobId)

The identifier for an import job

Example: B79F5F05-06E2-4D12-A5AE-AD9BC308FCCF

query Parameters

limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

head/import/jobs/{importJobId}/result

Request samples

curl
Java
Node.js
JavaScript

Response samples

400
401
403
404
406

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Get Import Job Result

Retrieves the Result of the specified import job.

SecurityBearer and ApiKeyAuth

Request

path Parameters

importJobId

required

string (ImportJobId)

The identifier for an import job

Example: B79F5F05-06E2-4D12-A5AE-AD9BC308FCCF

query Parameters

limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

header Parameters

If-None-Match

string

The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "*", or having a selected representation with an entity tag that does not match any of those listed in the field value.

For more details, please head over to RFC9110.

Responses

200

A response describing the result of an import job

304

Not Modified

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

get/import/jobs/{importJobId}/result

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"cursor": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtc2ciOiJZb3UgdGhvdWdodCB0aGlzIG1pZ2h0IGJlIHNvbWV0aGluZyBzZWNyZXQsIHJpZ2h0PyJ9.7xLHh_QS1f6oNd5oy5pXUBjDSQ-brOjBXxLbRDzOXAs",
"items": [{"fileName": "000000089948.png",
"mimeType": "image/png",
"fileSize": 150000,
"url": "https://example.com/images/test-image.png",
"status": "imported",
"assetId": "urn:aaid:aem:a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6"
},
{"fileName": "neom-ne3RC_Q9UEA-unsplash.jpg",
"mimeType": "image/jpeg",
"fileSize": 324629,
"status": "failed",
"error": {"type": "http://api.adobeaemcloud.com/adobe/meta/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "Could not import file neom-ne3RC_Q9UEA-unsplash.jpg, failed to preprocess: Failed to get download url for id:QqZmUXw658QAAAAAAAAGrw, not found"
}
}
]
}

Jobs

APIs for checking status and results of asynchronous jobs (assets and collections)

Get the status of an asynchronous job

Retrieves the current status of an async job created by the API. The job may be in progress, completed, or failed.

Async Job Polling Flow

When an operation returns a 202 Accepted response, follow this pattern:

202 Response: The operation returns a Location header pointing to this status endpoint
Poll Status: Call this endpoint to check job progress
- 200: Job is still processing. Check the state field and poll again after a short delay
- 200/303: Job is complete. Results are included in the response or available at the Location header

Job States

State	Description
`PROCESSING`	Job is still running
`COMPLETED`	Job finished successfully
`COMPLETED_WITH_ERRORS`	Job finished with some failures
`FAILED`	Job failed entirely

NOTE: This API is used by Adobe's Content Hub application. Using this API directly isn't covered in Adobe Support agreements.

SecurityBearer or ApiKeyAuth

Request

path Parameters

jobId

required

string

ID of an asynchronous job

Examples:

sample-job-id 542c88b4-e136-4341-9221-ae42d3d70b10

Responses

200

The current status of the async job (processing, completed, or failed).

303

The job has finished executing and results are available at the indicated location.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

401

Unauthorized. Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/jobs/{jobId}/status

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"jobId": "85f7c90a-a252-4e82-8cf3-3c989829cdf9",
"state": "PROCESSING"
}

Assets Author API (2026.04-experimental)

Assets

Get an asset

path Parameters

header Parameters

Delete asset

path Parameters

query Parameters

Search for assets based on specified criteria

query Parameters

Request Body schema: application/jsonmultipart/form-dataapplication/jsonrequired

Returns the originally uploaded binary for the asset

path Parameters

header Parameters

Returns a list of static renditions of an asset

path Parameters

header Parameters

Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset

path Parameters

query Parameters

header Parameters

Events

Asset processing completed eventWebhook

Request Body schema: application/json

Asset deleted eventWebhook

Request Body schema: application/json

Asset downloaded eventWebhook

Request Body schema: application/json

Asset metadata updated eventWebhook

Request Body schema: application/json

Asset published eventWebhook

Request Body schema: application/json

Asset unpublished eventWebhook

Request Body schema: application/json

Asset import completed eventWebhook

Request Body schema: application/json

Metadata

Head request for asset metadata

path Parameters

Delivers the specified asset's metadata

path Parameters

header Parameters

Updates the asset's assetMetadata properties

path Parameters

header Parameters

Request Body schema: application/json-patch+json

Relations

Get the asset relations for an asset

path Parameters

query Parameters

header Parameters

Create new asset relations for an asset

path Parameters

Request Body schema: application/jsonrequired

Get the asset relations for an asset filtered by relation type

path Parameters

query Parameters

header Parameters

Delete all asset relations of the given relation type for an asset

path Parameters

Delete an asset relation for an asset

path Parameters

Get the relation types for an asset

path Parameters

query Parameters

header Parameters

Import

Import From Url

Requirements for Large Files (≥10GB)

Pre-Import Validation:

Common Implementation Examples:

Technical Reference:

Request Body schema: application/jsonrequired

Head request for import job status

path Parameters

Get Import Job Status

path Parameters

header Parameters

Head request for import job result

path Parameters

Request Body schema:
application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required