> For the complete documentation index, see [llms.txt](https://help.pixboost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.pixboost.com/api/optimise.md).

# Optimise

API endpoint - `/api/2/img/[IMAGE-URL]/optimise`

## Description

**Optimise** - optimises images using lossy compression automatically.

## Parameters

**dppx** (optional) - Number of dots per pixel defines the ratio between device and CSS pixels. The query parameter is a hint that enables extra optimisations for high density screens. The format is a float number in the same format as window\.devicePixelRatio.

**trim-border**(optional) - Will remove the edges of the image with the same color, if the option specified.

## Examples

* `dppx=2` - sending a hint to the API that screen has DPI=2

| Parameters                                                                                                                                                                                          |                                                                                                                                                                                                          Image                                                                                                                                                                                                          |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Original                                                                                                                                                                                            |                                                                                                                                                         ![](https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/asis?auth=MTA0ODU5NDA0NQ__)                                                                                                                                                        |
| No parameters                                                                                                                                                                                       |                                                                                                                                                       ![](https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/optimise?auth=MTA0ODU5NDA0NQ__)                                                                                                                                                      |
| dppx=2                                                                                                                                                                                              |                                                                                                                                                   ![](https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/optimise?dppx=2\&auth=MTA0ODU5NDA0NQ__)                                                                                                                                                  |
| trim-border                                                                                                                                                                                         |                                                                                                                                                ![](https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/optimise?trim-border\&auth=MTA0ODU5NDA0NQ__)                                                                                                                                                |
| background prompt: A sun-drenched coastal rooftop terrace at golden hour. Out-of-focus ocean and distant modern skyline. Soft, warm ambient light, high-end lifestyle vibe, shallow depth of field. | ![](https://pixboost.com/api/2/img/https://pixboost.com/img/demos/tshirt.jpg/optimise?background=uP41RpNXujw7EZxBjYjI2%2Fv80NRVtGzKbJjvMYAcV%2FubKKHBNnfw9Tz%2FsKqDscFSURIAmkBpn0EibvgHU0WQ1U0UVklXK3a5kNgZaIjRhojHEPncbXOu3BRBztvn351hX8xFbYeqa91I%2BlCmhATcQRXnN7muXQFgdUpRW%2BicKXQHJHTS2qpEPOa0HfzQVUJuXlJ73h53iqvKS28TF8IKtNlmomwIG5K4%2BkeQRJDMmNUZ19Mbpx6%2FjFq1vYn0Lg3qBfNsiOGM7tbnXYSW\&auth=MTA0ODU5NDA0NQ__) |

**You can see URL of the examples by "right-click -> Copy Image address"**