• Are you a partner? Please find our certification tracks on our legacy Academy.

Using the Images API

Using the Contentstack Images API

Welcome, developers, to the Contentstack Images API! As you may know, images are an integral part of any digital experience, and we understand the importance of delivering optimized images quickly and efficiently. That's why we've created the Contentstack Images API, a powerful tool that allows you to manipulate, optimize, and deliver images to your web and mobile applications. Whether you're new to the platform or a seasoned developer, this guide will provide you with everything you need to know to get started with the Contentstack Images API. So let's dive in and explore the possibilities of this powerful tool together!

Here are three advantages to using the Contentstack Images API:

  1. Performance: The Contentstack Images API allows you to deliver optimized images at scale, reducing load times and improving the overall performance of your web and mobile applications.

  2. lexibility: With the Contentstack Images API, you have the flexibility to resize, and transform images in real-time, giving you the ability to customize images to fit any layout or design.

Trying out the Image Delivery API

The quickest way to get started with the Image Delivery API is to try it out with the online documentation.  

Resize an image on the fly

Contentstack's Images API resizes images on the server and provides the resized file in the response.  This is highly performant as the resized image is stored in the CDN cache on the Contentstack side.

Exercise:  Resize an image with the Contentstack Images API

1. Go to the following URL, https://www.contentstack.com/docs/developers/apis/image-delivery-api/#resize-images

2. Update the width of the image and see the image size and dimensions being changed

CSforDev_L15_Response200.png


Exercise: Auto-optimizing images with webp

1. Navigate to the Automate Optimization section of the documentation, https://www.contentstack.com/docs/developers/apis/image-delivery-api/#enable-auto-optimization

2. Leave the default as webp in the query parameters

CSforDev_L15_AutoOptimize.png

Using the Images API in your NextJS Applications

Pass the width, height, or auto attributes to the src property in the img tag

CSforDev_L15_ImagesAPI.png

Exercise: Use the Images API to resize the home world image

1.  Update the NextJS code to apply a width param of 150px to the home world image.  This resizes the image on the server-side and improves the performance of the page load.
CSforDev_L15_ImagesAPIresize.png