redocly logoAPI docs by Redocly

Adobe CC Libraries APIs (0.1)

Library Service

App-facing APIs for Adobe CC Libraries.

Retrieve libraries for a user

query Parameters
orderBy
string
Default: "-modified_date"

Sorting option for the response list. Reverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) Multi-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) Sorting is not available for public libraries.

Possible Values

  • name: Sort by the name.
  • modified_date: Sort by the last modified date.
start
string >= 0
Default: "0"

The first result to include for a paged response, 0-based. This parameter is required if a limit is specified. Paging is not available for public libraries.

limit
string >= 1
Default: "10"

The number of libraries to return for a paged response. Paging is not available for public libraries.

Possible Values

  • Min: 1.
  • Max: 10.
owner
string
Default: "all"

Customize which libraries to include in the response, based on ownership.

Possible Values

  • private: Libraries owned by the user.
  • incoming: Libraries shared with the user. This may include person-to-person shared libraries as well as libraries accessible via group ownership.
  • public: Libraries the user has followed.
  • all: All of the above except public.
selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
toolkit
string
Default: "none"

Customize which toolkit libraries to include in the response.

Possible Values- all: Include all toolkit libraries.

  • none: Do not include any toolkit libraries.
  • <toolkit-id>: Include libraries matching a specific toolkit-id, or comma-separated list of toolkit-ids.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "libraries": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a library

query Parameters
invocation_mode
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
name
string

Human-readable name for library. Required for creating a new library (not for move/copy)

source
string

URN or public library ID of the source library. Required for copy.

self
string

URN or public library ID of the library to be moved. Required for move.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "source": "string",
  • "self": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "toolkit_id": "string",
  • "name": "string",
  • "storage_used": 0,
  • "document_id": "string",
  • "document_type": "string",
  • "creator": "string",
  • "ownership": "PRIVATE",
  • "created_date": 0,
  • "modified_date": 0,
  • "version": "string",
  • "region": "string",
  • "library_urn": "string",
  • "manifest_urn": "string",
  • "storage_path": "string",
  • "elements_count": 0,
  • "removed_elements_count": 0,
  • "bookmark": {
    },
  • "rendition_grid": {
    },
  • "collaboration": {
    },
  • "asset_acl": {
    },
  • "details": {
    },
  • "groups": [
    ],
  • "_links": {
    },
  • "searchable": true,
  • "rawName": "string",
  • "renditionGridMissing": true,
  • "assetSubType": "string",
  • "_fc": true,
  • "is_searchable": true,
  • "manifest_etag": "string"
}

Retrieve a specific library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

query Parameters
selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
libraryVersion
string

Retrieve a cached library response (if available) for the specified version. To ensure the most recent cached version, use the version, which is provided when retrieving the library list. If the cached version is unavailable for some reason, the live result will be returned. Using this parameter is optional, but is likely to provide substantially faster performance.

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "toolkit_id": "string",
  • "name": "string",
  • "storage_used": 0,
  • "document_id": "string",
  • "document_type": "string",
  • "creator": "string",
  • "ownership": "PRIVATE",
  • "created_date": 0,
  • "modified_date": 0,
  • "version": "string",
  • "region": "string",
  • "library_urn": "string",
  • "manifest_urn": "string",
  • "storage_path": "string",
  • "elements_count": 0,
  • "removed_elements_count": 0,
  • "bookmark": {
    },
  • "rendition_grid": {
    },
  • "collaboration": {
    },
  • "asset_acl": {
    },
  • "details": {
    },
  • "groups": [
    ],
  • "_links": {
    },
  • "searchable": true,
  • "rawName": "string",
  • "renditionGridMissing": true,
  • "assetSubType": "string",
  • "_fc": true,
  • "is_searchable": true,
  • "manifest_etag": "string"
}

Retrieve a specific library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "reason": "string",
  • "message": "string"
}

Delete a specific library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "reason": "string",
  • "message": "string"
}

Apply multiple operations to a single library serially.

Apply multiple operations to a library serially. The request payload for this endpoint consists of an array of requests. Requests in this array may reference values from the response of requests preceding them. This can be accomplished by using substitution variables, which are described here: https://wiki.corp.adobe.com/x/5xLOhw.

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

invocation_mode
required
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

if-match
string

The etag value, returns content only if the asset's etag is NOT the same.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
Array of objects (BatchPayloadElement)

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "responses": [
    ],
  • "requests": [
    ]
}

Restore Archived Elements

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

invocation_mode
required
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
id
string

Ignored if submitted. The result will have a different ID.

description
string

Description of new element

name
required
string

Display name for new element

type
required
string

Element type

required
object (ClientDeviceInfoPayload)
Array of objects (DbLibraryElementRepresentationData)

Add or associate existing content to the new element

sourceRef
string

Reference other content as inspiration for this element

object (ElementListPayload)
object (ElementListPayload)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "name": "string",
  • "type": "string",
  • "client": {
    },
  • "representations": [
    ],
  • "sourceRef": "string",
  • "source": {
    },
  • "self": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "string"
}

Permanently delete archived elements

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string",
  • "retryAfter": 0,
  • "_fc": true
}

Permanently delete an archived element

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementId
required
string

The ID of the requested element.

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string",
  • "retryAfter": 0,
  • "_fc": true
}

Retrieve the elements within a library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

query Parameters
orderBy
string
Default: "-modified_date"

Sorting option for the response list. Reverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) Multi-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) Sorting is not available for public libraries.

Possible Values

  • name: Sort by the name.
  • modified_date: Sort by the last modified date.
start
string >= 0
Default: "0"

The first result to include for a paged response, 0-based. This parameter is required if a limit is specified. Paging is not available for public libraries.

limit
string [ 1 .. 100 ]
Default: "10"

The number of results to return for a paged response. Paging is not available for public libraries.

Possible Values

  • Min: 1.
  • Max: 100.
type
string

Limits results to those identified with the provided element mimetype.

group
string

Limits results to those assigned to the provided group_id (can be either group_id or classifier#group_id). Parameters without a classifier will populate as $default#group_id. To specify ungrouped elements, use $none$

selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • representations: Flattened list of assets associated with the library element.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "elements": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create, copy, or move elements

Create a new element, or copy/move existing elements.

Create Element Create a single element. All elements require at least one asset-based or literal representation. When creating a new asset-based element (ex: images, thumbnails, video), upload the asset(s) BEFORE creating the element. Use the response(s) from the Upload Asset API call(s) as objects in the representations array when using this API to create a new element.

Move Elements Move one or more elements, which means delete it from its current location and create it in the target library (indicated by this API's libraryId path param). To move an element, use the self object in the request body of this API call.

  • elements: Array of element(s) to move, specified by Element ID ex. `{"id":""}.
  • id: The library where the element(s) currently exist, specified by Library URN.

Copy Elements Copy one or more elements, which means leave the original element untouched and create a copy of it in the target library (indicated by this API's libraryId path param). To copy an element, use the source object in the request body of this API call.

  • elements: Array of element(s) to move, specified by Element ID ex. `{"id":""}.
    • optionally provide a new name for the new element ex. `{"id":"", "name":"", "description":"description"}.
  • id: The library where the element(s) currently exist, specified by Library URN. If the source Library ID is the same as the target library, the element(s) will be duplicated.
path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

invocation_mode
required
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
id
string

Ignored if submitted. The result will have a different ID.

description
string

Description of new element

name
required
string

Display name for new element

type
required
string

Element type

required
object (ClientDeviceInfoPayload)
Array of objects (DbLibraryElementRepresentationData)

Add or associate existing content to the new element

sourceRef
string

Reference other content as inspiration for this element

object (ElementListPayload)
object (ElementListPayload)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "name": "string",
  • "type": "string",
  • "client": {
    },
  • "representations": [
    ],
  • "sourceRef": "string",
  • "source": {
    },
  • "self": {
    }
}

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "elements": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Move a library's elements to the archive

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string",
  • "retryAfter": 0,
  • "_fc": true
}

Update a specific library's element

Update a specific library's element. This API is intended solely for top-level element attribute updates. Please look to PUT /api/v1/libraries/{libraryId}/elements/{elementId}/representations for updates to element assets and representations.

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
elementIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "elementIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reason": "string",
  • "message": "string"
}

Retrieve a specific library's element

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementId
required
string

The ID of the requested element.

query Parameters
selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • representations: Flattened list of assets associated with the library element.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "storage_used": 0,
  • "created_date": 0,
  • "modified_date": 0,
  • "type": "string",
  • "source": "string",
  • "element_type": [
    ],
  • "thumbnail": {
    },
  • "groups": [
    ],
  • "representations": [
    ],
  • "details": {
    },
  • "assetSubType": "string",
  • "_fc": true,
  • "sourceRef": "string",
  • "_links": {
    },
  • "parent_id": "string",
  • "manifest_etag": "string"
}

Move a library's element to the archive

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementId
required
string

The ID of the requested element.

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string",
  • "retryAfter": 0,
  • "_fc": true
}

Add/Update/Delete element representations in existing library

Add/Update/Delete element representations in existing library. The representations array input includes all representations to be created, retained, or updated.

Special Cases

  • Create: New representations can be submitted alongside the existing renditions, but with no id field.
  • Retain: Existing representations with no changes should be submitted exactly as returned by the element.
  • Update: Changes to representations must include the accurate id for the exising entry and should include all fields, updated and not updated.
  • Delete: Element renditions missing from the payload will be removed from the element.

Notes

  • Representations referencing assets uploaded to the library (primary and secondary) are immutable. To update an uploaded asset representation, submit a new representation with no id field. This will effectively delete and replace it.
  • The representations array resulting from this call will contain different id values that the existing element and the payload submission.
path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementId
required
string

The ID of the requested element.

invocation_mode
required
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
id
string

Ignored if submitted. The result will have a different ID.

description
string

Description of new element

name
required
string

Display name for new element

type
required
string

Element type

required
object (ClientDeviceInfoPayload)
Array of objects (DbLibraryElementRepresentationData)

Add or associate existing content to the new element

sourceRef
string

Reference other content as inspiration for this element

object (ElementListPayload)
object (ElementListPayload)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "name": "string",
  • "type": "string",
  • "client": {
    },
  • "representations": [
    ],
  • "sourceRef": "string",
  • "source": {
    },
  • "self": {
    }
}

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "elements": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Update a specific library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string",
  • "retryAfter": 0,
  • "_fc": true
}

Upload an asset to a library

Upload a small file asset to an existing library. File asset size must be <5mb to use this API call. After uploading a file asset with this API, you can use the response in the representations array in the request body of a Create New Element API call.

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

invocation_mode
required
string

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.
header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: multipart/form-data
Representation-Data
string

A JSON object specifying the type of the uploaded asset.

Here is an example, where the uploaded asset file is a jpg image: { "type": "image/jpg" }

Representation-Content
string <binary>

The file to upload. Must be less than 5mb.

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "elements": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Search for Libraries and Library Elements

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
asset_type
Array of strings unique

library and/or element. Leaving this out of the request will get both by default, though element-only parameters like library_id or archived will isolate the result to elements.

library_id
string

Library ID (URN) to constrain an elements search to a single library (like "urn:aaid:sc:us:2f3268e9-039d-460f-8b07-8854f7677645"). Invalid if submitted with "asset_type": ["library"].

group
string

Isolate element results to a single group. Invalid if submitted with "asset_type": ["library"].

name
string

A name string to identify by library/asset name. Requires an exact match.

query_string
string

A general query string to search for libraries/assets. Includes partial matches.

created_date
Array of strings <date-time>

Start & end dates in epoch time (ms since epoch).

modified_date
Array of strings <date-time>

Start & end dates in epoch time (ms since epoch).

type
Array of strings

One or more types for elements, invalid if submitted with "asset_type": ["library"].

archived
boolean

Search specifically for archived elements (boolean true/false to isolate results to archived or non-archived). Invalid if submitted with "asset_type": ["library"].

orderBy
string

defaults to -modified_date, also accepts name. Use a minus sign prefix to note descending.

start
string

String value. For libraries lists, the requirement to integrate bookmarked responses requires us to use the field in a clever fashion beyond a simple positive integer.

limit
integer <int32>

Positive integer, defines the number of results to return for a paged response. Defaults to 10. Max limit for library searches is 10, max limit for element searches is 100.

owner
string

private (default), incoming, outgoing, public, or all. all does not include public until bookmarks are integrated into the USS search results.

selector
string

Customize response for larger/smaller data sets. (default [base response], rendition_grid, collaboration, details, full).

has_stock_content
boolean

Search for libraries that have stock content, or elements within a library that have stock content (boolean true/false to isolate results to stock content or all content).

stock_content_id
string

Search for elements with a specific Stock Content ID. Invalid if submitted with "asset_type": ["library"] or "has_stock_content": false.

spark_brand_urn
string

Search for elements with a specific Spark tracking data brand_urn.

spark_creator_id
string

Search for elements with a specific Spark tracking data creator_id.

spark_content_summary
string

Search for elements with a partial match within the Spark tracking data content_summary.

source_ref
string

Search for elements with a specific sourceRef.

Responses

Request samples

Content type
application/json
{
  • "asset_type": [
    ],
  • "library_id": "string",
  • "group": "string",
  • "name": "string",
  • "query_string": "string",
  • "created_date": [
    ],
  • "modified_date": [
    ],
  • "type": [
    ],
  • "archived": true,
  • "orderBy": "string",
  • "start": "string",
  • "limit": 0,
  • "owner": "string",
  • "selector": "string",
  • "has_stock_content": true,
  • "stock_content_id": "string",
  • "spark_brand_urn": "string",
  • "spark_creator_id": "string",
  • "spark_content_summary": "string",
  • "source_ref": "string"
}

Response samples

Content type
application/json
{
  • "total_items": 0,
  • "libraries": [
    ],
  • "elements": [
    ]
}

Library Service - Bookmarks

App-facing APIs specifically for Adobe CC Library Bookmarks.

Retrieves all bookmarks for a user

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "bookmarks": [
    ],
  • "_fc": true
}

Add bookmarks for user, one or multiple

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
Array of objects (DbLibraryBookmark)

Responses

Request samples

Content type
application/json
{
  • "bookmarks": [
    ]
}

Response samples

Content type
application/json
{
  • "bookmarks": [
    ],
  • "_fc": true
}

Update an existing bookmark by ID

path Parameters
bookmarkId
required
string

The ID of the requested bookmark.

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request Body schema: application/json
Array of objects (DbLibraryBookmark)

Responses

Request samples

Content type
application/json
{
  • "bookmarks": [
    ]
}

Response samples

Content type
application/json
{
  • "bookmarks": [
    ],
  • "_fc": true
}

Remove a bookmark

path Parameters
bookmarkId
required
string

The ID of the requested bookmark.

header Parameters
authorization
required
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Responses

Response samples

Content type
application/json
{
  • "reason": "string",
  • "message": "string"
}

Library Service - Public

App-facing APIs specifically for Adobe CC Public Libraries.

Retrieve a specific library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

query Parameters
selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
linkId
string

The ID associating the request with the public library landing page URL.

header Parameters
authorization
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

if-match
string

The etag value, returns content only if the asset's etag is NOT the same.

x-use-cdn
boolean

Set to true if the API is called from a CDN.

x-cdn-origin
string
Value: "melville"

Indicate which backend service should be used for a call from a CDN. Required for calls from a CDN.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "toolkit_id": "string",
  • "name": "string",
  • "storage_used": 0,
  • "document_id": "string",
  • "document_type": "string",
  • "creator": "string",
  • "ownership": "PRIVATE",
  • "created_date": 0,
  • "modified_date": 0,
  • "version": "string",
  • "region": "string",
  • "library_urn": "string",
  • "manifest_urn": "string",
  • "storage_path": "string",
  • "elements_count": 0,
  • "removed_elements_count": 0,
  • "bookmark": {
    },
  • "rendition_grid": {
    },
  • "collaboration": {
    },
  • "asset_acl": {
    },
  • "details": {
    },
  • "groups": [
    ],
  • "_links": {
    },
  • "searchable": true,
  • "rawName": "string",
  • "renditionGridMissing": true,
  • "assetSubType": "string",
  • "_fc": true,
  • "is_searchable": true,
  • "manifest_etag": "string"
}

Check the presence and fetch headers of a public library

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

query Parameters
linkId
string

The ID associating the request with the public library landing page URL.

header Parameters
authorization
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

x-use-cdn
boolean

Set to true if the API is called from a CDN.

x-cdn-origin
string
Value: "melville"

Indicate which backend service should be used for a call from a CDN. Required for calls from a CDN.

Responses

Response samples

Content type
application/json
{
  • "reason": "string",
  • "message": "string"
}

Retrieve a specific library's list of elements

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

query Parameters
orderBy
string
Default: "-modified_date"

Sorting option for the response list. Reverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) Multi-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) Sorting is not available for public libraries.

Possible Values

  • name: Sort by the name.
  • modified_date: Sort by the last modified date.
start
string >= 0
Default: "0"

The first result to include for a paged response, 0-based. This parameter is required if a limit is specified. Paging is not available for public libraries.

limit
string [ 1 .. 100 ]
Default: "10"

The number of results to return for a paged response. Paging is not available for public libraries.

Possible Values

  • Min: 1.
  • Max: 100.
type
string

Limits results to those identified with the provided element mimetype.

group
string

Limits results to those assigned to the provided group_id (can be either group_id or classifier#group_id). Parameters without a classifier will populate as $default#group_id. To specify ungrouped elements, use $none$

selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
linkId
string

The ID associating the request with the public library landing page URL.

header Parameters
authorization
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

if-match
string

The etag value, returns content only if the asset's etag is NOT the same.

x-use-cdn
boolean

Set to true if the API is called from a CDN.

x-cdn-origin
string
Value: "melville"

Indicate which backend service should be used for a call from a CDN. Required for calls from a CDN.

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "elements": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Retrieve a public library's element

path Parameters
libraryId
required
string

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementId
required
string

The ID of the requested element.

query Parameters
selector
string
Default: "default"

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • representations: Flattened list of assets associated with the library element.
linkId
string

The ID associating the request with the public library landing page URL.

header Parameters
authorization
string

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-key
required
string

The API key assigned to your API client account when you signed up.

x-request-id
string

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

if-none-match
string

The etag value, returns content only if the asset's etag is EXACTLY the same.

if-match
string

The etag value, returns content only if the asset's etag is NOT the same.

x-use-cdn
boolean

Set to true if the API is called from a CDN.

x-cdn-origin
string
Value: "melville"

Indicate which backend service should be used for a call from a CDN. Required for calls from a CDN.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "storage_used": 0,
  • "created_date": 0,
  • "modified_date": 0,
  • "type": "string",
  • "source": "string",
  • "element_type": [
    ],
  • "thumbnail": {
    },
  • "groups": [
    ],
  • "representations": [
    ],
  • "details": {
    },
  • "assetSubType": "string",
  • "_fc": true,
  • "sourceRef": "string",
  • "_links": {
    },
  • "parent_id": "string",
  • "manifest_etag": "string"
}