Preview and Delivery APIs

The Preview and Delivery APIs are GraphQL endpoints used to deliver content and media to any app on any channel. GraphQL is a query language for APIs that gives you a flexible way to query the data. It provides a unified interface for managing and delivering both content and media, so you can define endpoints with specified URLs. These endpoints host the schema, which is a strongly typed graph definition where endpoints understand the GraphQL language.

Unlike REST APIs, in GraphQL:

  • There is a formal request body and response format.
  • The endpoints are all serviced by a single controller.
  • No code is required to define an endpoint.

Since GraphQL endpoints are serviced by a single controller, you can use various tools to dispatch multiple queries in a single HTTP request in order to reduce network traffic.


The Preview and Delivery APIs use the following endpoints:

Preview API endpoint


Delivery API endpoint



You can send requests to the GraphQL server using the following GraphQL IDEs:

Preview API IDE


Delivery API IDE


To help get you started, we have compiled several examples.


You must authenticate with an API key. The key must be provided in HTTP requests to the API as an HTTP header with the name X-GQL-Token. To obtain an API key, use either the:

After you obtain a key, in the Integrated Development Environment (IDE), on the HTTP HEADERS tab, add the API key using the following format (replacing the example API key):


Do you have some feedback for us?

If you have suggestions for improving this article,