Image I/O
Learn how to provide source images for our API, how to configure output options, and what image formats are supported.
Our API supports several options to provide source images that need to be processed.
URL of the input image should be from 1 to 512 characters. The image must be accessible by our system.
{
"input": "https://letsenhance.io/docs/assets/samples/burger.jpg"
}
Our API also supports the ability to upload image content directly. Just make sure that all respective headers are set.
You can connect Cloud Storage and use it as a source for images. Currently, our API supports AWS S3 and Google Cloud Storage.
After connecting your Cloud Storage, you can refer the storage name as an input.
{
"input": "storage://storage-name/path/image-name.jpg"
}
Our API supports the following image formats as inputs: BMP, GIF, JPEG, PNG, TIFF, WEBP, AVIF, and HEIC.
Configuration of result output is optional.
By default, you may omit the output option from the request payload. In this case, our system stores the result in a temporary bucket with a lifespan of 24 hours and provides a public URL to the image.
Alternatively, you can use a connected Cloud Storage: just configure the path to the folder where you want to store results.
The following image formats are supported for the output: JPEG, PNG, WEBP, and AVIF.
You may also specify advanced output, like image format, metadata (e.g. DPI), and format-specific options like PNG compression level, JPEG quality or using JPEG progressive display type.
Basic Usage
Advanced Usage
Advanced Format Usage
{
"output": "storage://storage-name/result-path/image-name.jpg"
}
"output": {
"destination": "storage://storage-name/result-path/image-name.jpg",
"format": "jpeg",
"metadata": {
"dpi": 300
}
}
"output": {
"destination": "storage://storage-name/result-path/image-name.jpg",
"format": {
"type": "jpeg",
"quality": 85,
"progressive": true
}
}
See the full list of the advanced format-specific options below:
jpeg
png
avif
Name | Type | Description |
---|---|---|
quality | integer | Specifies the amount of JPEG lossy compression in the range 1 - 100. Defaults to 85. |
progressive | boolean | Progressive JPEG loads in a browser in successive waves until a clear picture is formed, thus improving the image loading speed. Used by default. |
Name | Type | Description |
---|---|---|
compression | string | Indicates compression effort that will be applied during the PNG image encoding. Should have one of the values:
|
Name | Type | Description |
---|---|---|
compression | string,
object | The AVIF codec supports both lossless and lossy modes of operation, so you can select the one that is appropriate for your goals. Should have one of the values:
|
Last modified 1mo ago