Skip navigation

Delivery REST API

Download OpenAPI specification:Download

Introduction

The Delivery API is a read-only REST API that serves published content from your Kontent projects.

Use the Delivery API to deliver large amounts of content to your website or app. The content is cached on the CDN level, which makes it quickly available from wherever you are. The Delivery API provides content filtering options that allow you to retrieve only the parts of the content you need.

All requests to the API must be made securely over HTTPS with TLS 1.2.

Production vs. Preview

You can work with the Delivery REST API in two modes:

  • Production – Get the published versions of content items.
  • Preview – Get the latest versions of content items. The latest version can come from both published and unpublished content items.

In both cases, you use the same endpoints to request data but with a different base URL.

To retrieve published content items from your project, use the production URL:
https://deliver.kontent.ai/<YOUR_PROJECT_ID>/items

Protect your content

The Delivery API is public by default. To protect your published content, use the Delivery API with secure access enabled.

To preview latest version of your content items from your project, use the preview URL:
https://preview-deliver.kontent.ai/<YOUR_PROJECT_ID>/items

If you want to preview the latest version of your content, you need to authorize your request.

  • JavaScript
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript const KontentDelivery = require('@kentico/kontent-delivery');   const deliveryClient = KontentDelivery.createDeliveryClient({ projectId: '<YOUR_PROJECT_ID>', previewApiKey: '<YOUR_PREVIEW_API_KEY>', defaultQueryConfig: { usePreviewMode: true, // Queries the Delivery Preview API. } });   const response = await deliveryClient.item('my_article') .toPromise();
  • TypeScript
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript import { IContentItem, createDeliveryClient, Elements } from '@kentico/kontent-delivery';   // Create strongly typed models according to https://kontent.ai/learn/tutorials/develop-apps/get-content/using-strongly-typed-models export type Article = IContentItem<{ title: Elements.TextElement; summary: Elements.RichTextElement; post_date: Elements.DateTimeElement; teaser_image: Elements.AssetsElement; related_articles: Article[]; }>;   const deliveryClient = createDeliveryClient({ projectId: '<YOUR_PROJECT_ID>', previewApiKey: '<YOUR_PREVIEW_API_KEY>', defaultQueryConfig: { usePreviewMode: true, // Queries the Delivery Preview API. }, });   const response = await deliveryClient.item<Article>('my_article') .toPromise();
  • C#
// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net using Kentico.Kontent.Delivery;   // Initializes a delivery client for previewing content IDeliveryClient client = DeliveryClientBuilder .WithOptions(builder => builder .WithProjectId("<YOUR_PROJECT_ID>") .UsePreviewApi("<YOUR_PREVIEW_API_KEY>") .Build()) .Build();   // Generate strongly typed models via https://github.com/Kentico/kontent-generators-net IDeliveryItemResponse<Article> response = await client.GetItemAsync<Article>("my_article"); Article item = response.Item;
  • PHP
// Tip: Find more about PHP SDKs at https://kontent.ai/learn/php // Defined by Composer to include required libraries require __DIR__ . '/vendor/autoload.php';   use Kentico\Kontent\Delivery\DeliveryClient;   $client = new DeliveryClient('<YOUR_PROJECT_ID>', '<YOUR_PREVIEW_API_KEY>');   $item = $client->getItem('my_article');
  • Java
// Tip: Find more about Java SDK at https://kontent.ai/learn/java import kentico.kontent.delivery.*;   // Initializes a Delivery client for preview DeliveryClient client = new DeliveryClient( DeliveryOptions.builder() .projectId("<YOUR_PROJECT_ID>") .previewApiKey("<YOUR_PREVIEW_API_KEY>") .usePreviewApi(true) .build() );   // Registers the model class for articles // Tip: Create strongly typed models according to https://kontent.ai/learn/strongly-typed-models client.registerType(Article.class);   // Gets an article CompletionStage<Article> article = client.getItem("my_article", Article.class);
  • Ruby
# Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby require 'delivery-sdk-ruby'   delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<YOUR_PROJECT_ID>', preview_key: '<YOUR_PREVIEW_API_KEY>' delivery_client.item('my_article').execute do |response| puts response.to_s end
  • Swift
// Tip: Find more about Swift SDK at https://kontent.ai/learn/ios import KenticoKontentDelivery   let client = DeliveryClient.init(projectId: "<YOUR_PROJECT_ID>", apiKey: "<YOUR_PREVIEW_API_KEY>")   // More about strongly-typed models https://github.com/Kentico/kontent-delivery-sdk-swift#using-strongly-typed-models client.getItem(modelType: Article.self, itemName: "my_article") { (isSuccess, itemResponse, error) in if isSuccess { if let article = itemResponse.item { // Use your item here } } else { if let error = error { print(error) } } }
  • cURL
curl --request GET \ --url https://preview-deliver.kontent.ai/<YOUR_PROJECT_ID>/items/my_article \ --header 'authorization: Bearer <YOUR_PREVIEW_API_KEY>'

For the Delivery Preview API, you can use two concurrent API keys, Primary and Secondary. For more details on how to work with content preview, see configuring preview.

Authentication

By default, the Delivery API does not require authentication. However, if you enable secure access for the Delivery API or use the Delivery Preview API, you need to authenticate your requests with valid API keys.

To get data from the Delivery API with secure access enabled or the Delivery Preview API, send your requests over HTTPS using the Authorization header in the following format: Authorization: Bearer <YOUR_API_KEY>. Requests with an incorrect or missing Authorization header will fail with an error.

To get your API key, go to Kontent > Project settings > API keys. The API keys provide access to a single Kontent project. You will need different API keys for each of your projects.

Try the API with Postman

Try out any of the Kontent APIs with Postman! 📫 The Postman collection is regularly updated and contains endpoints for all Kontent REST APIs, just like in the API references.

SDKs

We offer the following SDKs to help you interact with the API. However, you don't need an SDK to use the API.

If you want to create your own SDK, see our guidelines for SDK developers.

API limitations

API requests limit

Requests made to the Delivery API count towards the overall API Calls limit set in our Fair Use Policy.

Requests made to the Delivery Preview API, which lets you preview unpublished content, do NOT count towards the API Calls limit.

Change processing time

The Delivery API processes changes to your content items in sequential order, one after another. In high-volume scenarios, this can lead to delays between making a change and seeing the results of that change in the API. See the following example scenarios for details.

Example A: Editing and publishing content items

If you publish a content item, the API processes this change in a few seconds. When publishing larger amounts of content, there can be a delay in availability of that content in the API.

For example, if you publish 100 content items, the first item will be available a few minutes sooner than the last one.

Example B: Editing content types

When you change a content type, the API needs to process all content items based on that type. If your changes affect hundreds or thousands of content items, the API recalculates the content of each item. While this is happening, any new changes to content items need to wait before being processed by the API.

For example, imagine you have an Article content type with 100,000 content items based on that type. If you add an element to the content type, the API goes through the items and begins updating their content. Given the high number of items, this process can take up to a few hours.

Until the API finishes processing the Article items, any subsequent content changes need to wait. If you publish a content item right after modifying the Article content type, the published item appears in the API only after the type change was fully processed.

Example C: Changing project localization settings

We strongly recommend against changing language codenames on live projects with lots of content. This action might lead to temporary inconsistencies that might affect content in your web app.

If you change a project language's codename, the API needs to process all items that have content in that language. Until this change is fully processed, the API might return some items with the old language codename and some items with the new language codename.

Rate limitation

Rate limits specify the number of requests you can make to the Delivery API within a specific time window.

Your first request to the Delivery API is uncached and its response is stored in our CDN. If you repeat that request, you get a cached response. That response is cached until content in your project changes.

For uncached requests that reach the Delivery API, we enforce a rate limitation of 100 requests per second and 2000 requests per minute. These are unique requests for uncached data.

For cached requests that hit our CDN, we don't enforce any rate limits. These are repeated requests for cached data. You can make an unlimited number of requests to the CDN.

When you reach the rate limit, the API rejects the request and responds with a 429 HTTP error. This error comes with the Retry-After header that tells you how many seconds you need to wait before retrying your request. Each failed request is perfectly safe to retry. If you begin to receive 429 errors, reduce the frequency of your requests.

Response size

When you request a single content item or list of items, the Delivery API limits the maximum number of items returned within a response to 2000 items. This number covers both the items that directly match the specified query and the linked items returned in the response's modular_content property.

You can find whether your requests are close to the limit by looking at the X-Request-Charge header.

If the X-Request-Charge value of your requests exceeds 1000, we recommend applying more specific filters and checking if a lower value for the depth parameter works for you. Fewer items returned per response means shorter response times and better performance for your app.

Errors

The API returns standard HTTP status codes to indicate the success or failure of a request. In general, status codes in the 2xx range indicate a successful request, status codes in the 4xx range indicate errors caused by an incorrect input (for example, providing incorrect API key), and status codes in the 5xx range indicate an error on our side.

HTTP status codes summary

Status code

Description

400 Bad Request

The request was not understood. Check your request for a missing required parameter or an invalid query parameter value.

401 Unauthorized

The provided API key is invalid or missing.

403 Forbidden

The provided API key is invalid for the requested project.

404 Not Found

The requested resource doesn't exist. Try checking the resource name for typos.

405 Method Not Allowed

The requested HTTP method is not supported for the specified resource.

429 Too Many Requests

The rate limit for the API has been exceeded. Try your request again after a few seconds as specified in the Retry-After header.

5xx Internal Error or Service Unavailable

Something went wrong on our side. Try your request again after a few seconds and use a retry policy.

Resolving errors

For troubleshooting failed requests, the API provides error messages defined in a consumable format to help you identify and fix the issue.

message
required
string

The error message explaining what caused the error.

request_id
required
string Nullable

The performed request's unique ID.

error_code
required
integer <int32> [ 1 .. 500 ]

The specific internal code for the type of error. Only useful for finding patterns among error requests.

specific_code
required
integer <int32>

Only useful for finding reasons behind failed requests in specific cases.

Copy
Expand all Collapse all
{
  • "message": "The requested content item 'sample_item' was not found.",
  • "request_id": "|657e8eba55d8bf4a9a5ad9074038cd2e.813e828d_",
  • "error_code": 100,
  • "specific_code": 0
}

If you cannot identify and resolve an issue with your API call, you can contact us with the response status and the request ID you get in the error response.

Secure access

By default, the Delivery API does not require authentication. This means your assets and published content items are publicly available.

You can enable secure access for your project to require authenticated requests. You'll then need to use an API key when getting content items.

Because the Delivery API is designed for continuous retrieval of published content, there is no expiration date for the Primary or Secondary API keys. The API keys are scoped per project. This means you need a separate API key for each project in Kontent. All users within a single project share the same Delivery API keys.

If you have advanced asset management, you can also set up secure assets for your project. For more details, check how to restrict public access.

Revoking API keys

The Delivery API with secure access enabled and the Delivery Preview API both use two concurrent API keys, Primary and Secondary. In certain situations, you may need to revoke one of these keys and generate a new one. For example, when you suspect unauthorized key use or when a developer with access to the API key has left your company.

For situations like these, one or both of the API keys can be regenerated. Generating a new key will replace the old key. This process can take up to a couple of minutes. Requests made with a revoked API key will then receive a 401 Unauthorized HTTP status in the response.

Keep your API keys secure

There is no expiration date for the Primary or Secondary API key. However, we recommend that you regenerate the API keys periodically to prevent the keys from being compromised.

Learn more in Securing public access and Configuring content preview.

Filtering content

When getting content items, you can filter your items by building query parameters from content elements and system properties. Check out our tutorial on filtering content items, which covers the basic use of common filtering parameters. Or read on for a deep dive.

Filtering does not apply to content items returned in the modular_content object property.

If you want to get only a specific set of elements from content items, use projection.

Filtering by system values

To filter by system property values, you need to use a query parameter in the system.<property_name> format. The system properties are id, collection, name, codename, language, type, last_modified, and workflow_step. For example, to retrieve only content items based on the Article content type, use system.type=article as a query parameter.

Filtering by element values

To filter by content element values, you need to use a query parameter in the elements.<element_codename>=<value> format. For example, to retrieve only content items whose number element named Price has a value of 16, use elements.price=16 as a query parameter.

Joining multiple query parameters

You can join multiple query parameters using the & character. Queries with two or more filtering parameters are more restrictive because the individual query parameters are merged with a logical conjunction (AND).

For example, the query system.type=article&elements.category[contains]=nature will return article content items that are tagged with the word Nature.

Filtering operators

You can use the following filtering operators with both the system properties and element values.

All operators are case-sensitive.

Operator

Description

Example

Use with

[eq](same as =)

Property value equals the specified value.

system.type=article

system.type[eq]=article

Simple types

[neq]

Property value does not equal the specified value.

system.type[neq]=article

system.workflow_step[neq]=archived

Simple types

[empty]

Property value is empty.

elements.title[empty]

elements.author[empty]

For rich text, use the equals operator, elements.content[eq]=<p><br></p>.

Simple types and arrays

[nempty]

Property value is not empty.

elements.title[nempty]

Simple types and arrays

[lt]

Property value is less than the specified value.
More in Comparing values.

elements.price[lt]=10

Simple types

[lte]

Property value is less than or equal to the specified value.
More in Comparing values.

elements.price[lte]=4

Simple types

[gt]

Property value is greater than the specified value.
More in Comparing values.

elements.price[gt]=10

Simple types

[gte]

Property value is greater than or equal to the specified value.
More in Comparing values.

elements.price[gt]=10

Simple types

[range]

Property value falls within the specified range of two values, both inclusive.
More in Comparing values.

elements.price[range]=10.5,50

Simple types

[in]

Property value is in the specified list of values.

elements.price[in]=8.5,9,10.5

Simple types

[nin]

Property value is not in the specified list of values.

system.type[nin]=home,page

Simple types

[contains]

Property with an array of values contains the specified value.
The [contains] operator cannot be used on strings.

elements.category[contains]=nature

elements.custom[contains]=ABC

Arrays

[any]

Property with an array of values contains at least one value from the specified list of values.

elements.category[any]=technology,nature

Arrays

[all]

Property with an array of values contains all of the specified values.

elements.category[all]=technology,mobile

Arrays

Arrays vs. simple types

You can use the [contains], [any], and [all] filtering operators only on arrays. The content elements that support these operators are custom elements (see limitations below), linked items, multiple choice, and taxonomy.

For custom elements, the [contains], [any], and [all] filters work only if the element's value is a stringified array of strings such as "[\"DE\",\"US\",\"UK\"]". The [contains], [any], and [all] operators can NOT be used on asset elements.

Comparing values

The [lt], [lte], [gt], [gte], and [range] filtering operators work best with numbers. For example, you can retrieve products with price larger or equal to 15 by using elements.price[gte]=15.

Filtering by date-time values

Properties that store dates are represented as strings. For example, this includes the last_modified system property and date & time content elements.

If you use filtering operators on properties with string values, the Delivery API tries to perform a string comparison. For instance, you can retrieve content items modified during February and March by using a query such as system.last_modified[range]=2020-02-01,2020-04-01, specifying the start date within the range and end date outside the range.

Projection

When getting content items or content types, you can specify which elements to return by using the elements query parameter.

  • For items, the parameter applies to content items returned within both the items array and modular_content object property.
  • For types, the parameter applies to content types returned within the types array.

Examples

By using elements=title as a query parameter, the elements property in each content item will contain only the element with the codename title, or, if the item doesn't have an element with such codename, the elements property will be empty.

For multiple elements, you can use a query parameter such as elements=title,summary,related_articles to retrieve only the elements with codenames title, summary, and related_articles.

Excluding the system properties

Projection does not apply to the system properties. This means that you cannot omit the system object from the response using any query.

Linked content and components

Kontent offers several ways to compose and structure your content through rich text and linked items elements.

  • Linked items elements are used to reference other content items.
  • Rich text elements are used to compose your content with text, images, components, and content items. Components and content items are useful for inserting structured content into a specific point in the text.

Components 101

Rich text elements can contain components.

  • A component is a single-use content item.
  • It has the same structure as a content item.
  • It is based on a specific content type.
  • Unlike a content item, a component only exists inside its rich text element.

Retrieve linked content

When retrieving items using the Delivery API, the contents of all components and content items in the rich text and linked items elements are stored in the modular_content object property of the API response.

When enumerating the items in your project using the Delivery API, the modular_content object property will contain only components, not content items used in linked items elements.

The contents of modular_content, that is the individual components and content items, are not ordered. See linked items and rich text elements for details on how ordering is done within the elements.

For historical reasons, the property is called "modular_content" instead of "linked_content".

Linked content depth

Content items can reference other content items using linked items or rich text elements. These linked items can reference other items recursively. By default, the API returns only one level of linked items.

  • To include more than one level of linked items in response, set the depth query parameter to 2 or more.
  • To exclude all linked items, set the depth query parameter to 0.

When retrieving content, linked items cannot be filtered.

Components are not affected by the depth query parameter as they are an integral part of their rich text element. Components are always present in the API response. Components can be nested up to six levels deep.

Content items

Content items represent specific pieces of content based on a specific content type. To retrieve specific items from your project, either provide a codename for one item or filter all items using parameters. By default, the Delivery API returns content items in the default language.

Content item object

system
required
object

The content item's system properties.

elements
required
object

The item's elements with values for the specific language.

The order of the element objects might not match the content element order in the UI.

Copy
Expand all Collapse all
{
  • "system":
    {
    • "id": "335d17ac-b6ba-4c6a-ae31-23c1193215cb",
    • "collection": "default",
    • "name": "My article",
    • "codename": "my_article",
    • "language": "en-US",
    • "type": "article",
    • "sitemap_locations": [ ],
    • "last_modified": "2019-03-27T13:21:11.38Z",
    • "workflow_step": "published"
    },
  • "elements":
    {}
}

List content items

get/{project_id}/items
See full URL

Delivery API

https://deliver.kontent.ai/{project_id}/items

Delivery Preview API

https://preview-deliver.kontent.ai/{project_id}/items

Retrieve a list of content items from your project. By default, the API returns an unfiltered paginated list of content items ordered alphabetically by codename. The response size is limited to 2000 items.

The modular_content object property will contain both components and linked items in the API response. See Linked content and components for more details.

If you need to export all content items from your project, we recommend using the Enumerate content items endpoint.

You can change the order by specifying the order query parameter. You can customize pagination by specifying both the skip and limit query parameters. Note that the limit parameter affects only the items property, not modular_content.

Get only the items you need

To retrieve specific content items, use the filtering parameters in your requests. For example, you can request items tagged with a taxonomy term, items of a specific type, or items modified in the past three days.

path Parameters
project_id
required
string

Identifies your project.

If you're using environments, the project ID becomes environment ID and specifies one of the project's environments.

query Parameters
language
string

Determines which language variant of content items to return. By default, the API returns content in the default language.

If the requested content is not available in the specified language variant, the API follows the language fallbacks as configured in the Localization settings of your project.

elements
Array of strings

Determines the elements to retrieve using a comma-separated list of element codenames. The elements query parameter applies to all content items within the response.

If not specified, all elements are retrieved. For more details, see Projection.

order
string

Determines the order of the retrieved objects. By default, the objects are sorted alphabetically by their codenames from A to Z in descending order.

To sort the requested objects in ascending order, set the order to <property_name>[asc] where <property_name> is the name of the object property you want to sort by. For example, order=elements.title[asc] or order=system.codename[asc]. Similarly, to sort in descending order, use the [desc] modifier. You can sort by any properties in the API response.

Examples

  • Sort by date – order=system.last_modified[desc]
  • Sort by a content item name – order=system.name[asc]
  • Sort by an element value – order=elements.<element_codename>[asc]
depth