# 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/http://www.midday.coffee/assets/cup.jpeg/asis?auth=MTA0ODU5NDA0NQ__)                     |
| No parameters |                   ![](https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?auth=MTA0ODU5NDA0NQ__)                   |
| dppx=2        |               ![](https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?dppx=2\&auth=MTA0ODU5NDA0NQ__)               |
| Original      |          ![](https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cups/keep-calm-2816357__340.jpg/asis?auth=MTA0ODU5NDA0NQ__)         |
| trim-border   | ![](https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cups/keep-calm-2816357__340.jpg/optimise?trim-border\&auth=MTA0ODU5NDA0NQ__) |

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.pixboost.com/api/optimise.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.