Use the 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.

You can work with the Delivery API in two ways – either retrieve published versions of content items or preview their yet unpublished versions. In both cases, you use the same methods to request data but with a different base URL.

Retrieve published content items from your project using the production URL:
https://deliver.kontent.ai/<YOUR_PROJECT_ID>/items

Preview unpublished content items from your project using the preview URL:
https://preview-deliver.kontent.ai/<YOUR_PROJECT_ID>/items

If you want to preview unpublished content in your project, you need to authorize your request.

JavaScript
// Tip: Find more about JS/TS SDKs at https://docs.kontent.ai/javascript
const KontentDelivery = require('@kentico/kontent-delivery');
 
const deliveryClient = new KontentDelivery.DeliveryClient({
  projectId: '<YOUR_PROJECT_ID>',
  previewApiKey: '<YOUR_PREVIEW_API_KEY>',
  globalQueryConfig: {
    usePreviewMode: true, // Queries the Delivery Preview API.
  },
  typeResolvers: [
    // Create strongly typed models according to https://docs.kontent.ai/strongly-typed-models
    new KontentDelivery.TypeResolver('article', (rawData) => new Article)
  ]
});
 
deliveryClient.item('my_article')
  .toObservable()
  .subscribe(response => console.log(response));

TypeScript
// Tip: Find more about JS/TS SDKs at https://docs.kontent.ai/javascript
import { ContentItem, DeliveryClient, Elements, TypeResolver } from '@kentico/kontent-delivery';
 
// Create strongly typed models according to https://docs.kontent.ai/tutorials/develop-apps/get-content/using-strongly-typed-models
export class Article extends ContentItem {
    public title: Elements.TextElement;
    public summary: Elements.TextElement;
    public post_date: Elements.DateTimeElement;
    public teaser_image: Elements.AssetsElement;
    public related_articles: Article[];
}
 
const deliveryClient = new DeliveryClient({
    projectId: '<YOUR_PROJECT_ID>',
    previewApiKey: '<YOUR_PREVIEW_API_KEY>',
    globalQueryConfig:  {
        usePreviewMode: true, // Queries the Delivery Preview API.
    },
    typeResolvers: [
        new TypeResolver('article', (rawData) => new Article)
    ]
});
 
deliveryClient.item<Article>('on_roasts')
    .toObservable()
    .subscribe(response => console.log(response));

C#
// Tip: Find more about .NET SDKs at https://docs.kontent.ai/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://docs.kontent.ai/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://docs.kontent.ai/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://docs.kontent.ai/strongly-typed-models
client.registerType(Article.class);
 
// Gets an article
CompletionStage<Article> article = client.getItem("my_article", Article.class);
// To use the code for Android projects, see http://docs.kontent.ai/android

Ruby
# Tip: Find more about Ruby SDKs at https://docs.kontent.ai/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://docs.kontent.ai/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 the keys and content preview as a whole, see configuring preview for items.

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 work with 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 for the API, go to Kentico Kontent > Project settings > API keys. The API keys provide access to a single Kentico Kontent project. You will need different API keys for each of your projects.

We offer several SDKs to help you interact with the API. However, no SDK is required to use the API.

• JavaScript/TypeScript SDK
• .NET SDK
• Java SDK
• PHP SDK
• Swift SDK
• Ruby SDK

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

Kentico Kontent 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.

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

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.

By default, the Delivery API does not require authentication but you can enable secure access for the project to force authenticated requests.

With secure access, you can use two concurrent API keys, Primary and Secondary. For more details on how to work with the keys, see how to restrict public access.

Because the Delivery API is designed for continuous retrieval of published content, there is no expiration date for the Primary or Secondary API key.

The API keys are scoped per project. This means you need a separate API key for each project in Kentico Kontent. All users within a single project share the same Delivery 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.

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.

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.

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.

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.

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.

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 (conditions apply), linked items, multiple choice, and taxonomy. The operators can be used on custom elements 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.

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.

Kentico 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.

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 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.