Introduction

The GraphQL Asset Management API is designed for building back-office applications and automating processes. You can use it to query and report on assets, to update assets and to integrate with your existing back end services. In future we will be extending the API coverage to include other features related to management of the Amplience platform.

To use the API, you'll need a client ID and secret. Visit the authentication section for information about how to use the client ID and secret to obtain an access token that must be included with each request.

API Playground

You can use the Amplience playground to explore your content or test queries and mutations. visit the playground page for more information.

Usage

In the usage section, you will find all the information you need pertaining to the endpoint for all requests to the GraphQL Asset Management API, and authentication. There is also some details about how to include a token in an API request, as well as some examples of errors. You will learn how errors are formatted and how to interpret status codes.

Limits

On the limits page, we have outlined all the limits regarding the GraphQL asset management API. This includes the rate limits, mutation limits and complexity limits. In the complexity limits section you will also find some examples of how our complexity limits work to help you get a better understanding of how they may affect your queries and mutations.

Examples

For anyone who would like more information regarding queries and mutations, this page contains several examples to help perform actions with your assets using this API. Some of which include updateAssets, deleteAssets and more.

Conventions

This page will help you understand the conventions of the GraphQL Asset Management API, and how several aspects of the API are structured to ensure optimum usage. You will understand how nodes and edges work, as well as Pagination and PageInfo.

You will also learn the conventions of the AssetSearch aspect of the API. We explain how the syntax of an AssetSearch queries needs to be structured, with detailed examples regarding the usage of wildcards, keywords, booleans, parentheses and more.

Concepts

In the concepts page, we offer more information about the viewer, asset repositories and media hub ID's.