API Reference

This topic provides a clear explanation of the fallback policy for images and instructions on how to use debugging mode for a better implementation experience.

Image availability guarantee

We understand the critical importance of images in the end-user experience. To ensure that there is never an interruption in content delivery, the API is designed to automatically revert to the original image in any failure scenario. Whether due to a transformation error, temporary instability, or any issue with the API implementation, your end-users will continue to have a seamless visual experience.

Simplified debugging

To facilitate problem detection and resolution during the API implementation phase, add the query string ?debug=true to the end of the image URL. This activates debugging mode, which provides real-time visibility of errors.

Example of Usage with Debug:

To activate debugging mode, simply append ?debug=true to your URL.

Sending an unsupported parameter to the API /convert:unsupported/ and activating debugging mode as in the URL below will result in the following error response:

https://img.voidr.co/my_project/convert:unsupported/fetch/https://images.unsplash.com/photo-1561336313-0bd5e0b27ec8

{"error":"convert format \"unsupported\" not available","details":null}

🚧

Caution when using debugging mode!

We recommend using debugging mode only during development and testing to avoid exposing error information in a production environment.