Image - Introduction

You can use Image Delivery APIs by just appending queries to the image URL: {image_url}?environment={environment_name}&query_parameter

For example, to resize the width of an image to 100px, you need to append {&width={100} to the image URL. So, the API request would be:

https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/owl.jpg?environment=production&width=100

You can also use multiple queries in a single API request.

{image_url}?environment={environment_name}&width={width_value}&height={height_value}&resize-filter={resize-filter_value}

In this case, the API request would form like this:

https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/owl.jpg?environment=production&width=500&height=550&resize-filter=nearest

When making Image Delivery API requests, you must include the environment query parameter:

{image_url}?environment={environment_name}&query_parameter

Using the environment parameter ensures that requests are routed through Contentstack’s Content Delivery Network (CDN). This approach provides the following benefits:

• Avoids routing requests through the Content Management API (CMA), which can cause rate limit errors and timeouts.
• Ensures higher rate limits and lower costs by serving images directly from the CDN.

NoteThe image must be published in the environment which is being passed as a query parameter.

Here’s an example of an asset URL:

https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/owl.jpg

If you notice the URL, you will see that it is made up of several strings. Here's the breakdown of these strings to understand what they are:

{base_url}/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename

Additional ResourceRefer to Understanding Asset URL document to know more about asset URL structure.

Please note that the above breakdown of strings of the asset URL is just for your understanding. This is the default pattern of all the asset URLs.

If the "Branches" feature is part of your plan, you will see an updated download URL format for all assets part of any branch, except the default main branch. The branch={branch_UID} query parameter is attached to the download URL.

For instance, if you upload an asset to the development branch, Contentstack generates the following asset download URL:

https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg?branch=development

For any asset that you upload to the main branch, Contentstack will continue to generate asset download URLs in the earlier format:

https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg

When working with this API documentation, you do not have to enter any of the above values. To make Image Delivery API requests, you simply need to append queries to the asset URL.