Image | Convert Formats

Auto format

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

Let’s try converting an image to GIF format.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

auto

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Headers

acceptoptionalstring

Enter value image/webp or image/avif.

Note: The internal server handling this API call does not support AVIF or WEBP formats. Hence this additional header needs to be included to receive the converted image. However, when running this query via Postman or on any browser that supports AVIF or WEBP format, the accept header is not required.

Example:

image/webp

Convert to GIF

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

Images can also be easily converted to PNG format.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

gif

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to PNG

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format_value}

JPEG is one of most common image formats.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

png

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to JPEG

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

A Progressive JPEG is an image file created using a compression method that displays higher detail in progression. When a Progressive JPEG image is loaded, it first loads a lower-quality pixelated version, and then gradually increases in quality and detail. Due to this, Progressive JPEG files (or its lower-quality version) loads faster than the baseline JPEG files.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

jpg

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to Progressive JPEG

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

AVIF images provide better compression and quality.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

pjpg

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to AVIF

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

WEBP images are usually lower in size and have good quality. The WEBP images files are currently supported only in Google Chrome, Opera, and Android browsers.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

avif

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to WEBP

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

WEBP images are of two types: Lossy and Lossless. In the former, the data lost while compression cannot be reversed, hence the quality can be lower. While with the later format, no data is lost while compression and quality remains the same even after compression.

Let’s try converting to WEBP Lossy first.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

webp

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to WEBP Lossy

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

Now let’s convert an image to WEBP Lossless format.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

webply

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production

Convert to WEBP Lossless

GET

https://images.contentstack.io/v3/assets/{stack_api_key}/{asset_uid}/{file_uid}/filename.jpg?environment={environment_name}&format={format}

Additional Notes:

The quality parameter can used only with JPEG, Progressive JPEG, AVIF, or WEBP (Lossy) image types.
The WEBP and AVIF image type is supported only by Google Chrome, Opera, and Android browsers.
GIF transcoding is not supported as of now.
If 'auto=webp' or 'auto=avif' is used with the format parameter, the browsers that support the WEBP format will ignore the format parameter.

Hide Parameters

Query Parameters

formatoptionalstring

Enter the format into which the source image needs to be converted.

Example:

webpll

environmentrequiredstring

Enter the environment scoped to your delivery token.

Example:

production