Sign in
images

Optimises a source image

Optimises an image and returns it in the next-gen format supported by the browser. The API knows about supported formats through the "Accept" header.

get/img/{imgUrl}/optimise

Path parameters

imgUrlstring required

Url of the original image including schema. Note that query parameters need to be properly encoded

Query parameters

dppxnumber float

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 that's the same format as window.devicePixelRatio.

save-data'off' | 'hide'

Sets an optional behaviour when Save-Data header is "on". When passing "off" value the result image won't use extra compression when data saver mode is on. When passing "hide" value the result image will be an empty 1x1 image. When absent the API will use reduced quality for result images.

trim-borderboolean

Removes the edges of the image that have exactly the same color.

Response

An optimised image

Changes

Changed in 5 of the 8 revisions of this API.516

  • cad07fafe7312See the full diff
    • ○

      the query request parameter dppx became optional

      request-parameter-became-optional

    • ○

      the query request parameter save-data became optional

      request-parameter-became-optional

  • 18cbc1c76caa1See the full diff
    • ○

      added the new optional query request parameter trim-border

      new-optional-request-parameter

  • f053d6fb3a381See the full diff
    • ○

      added the media type image/jxl for the response with the status 200

      response-media-type-added

  • a3e4afa484da2See the full diff
    • ○

      added the media type image/avif for the response with the status 200

      response-media-type-added

    • ○

      added the media type image/webp for the response with the status 200

      response-media-type-added

  • ac53f9796a0151See the full diff
    • ▲

      the query request parameter dppx became required

      request-parameter-became-required

    • ▲

      the query request parameter save-data became required

      request-parameter-became-required

    • ▲

      removed the media type image/avif for the response with the status 200

      response-media-type-removed

    • ▲

      removed the media type image/jxl for the response with the status 200

      response-media-type-removed

    • ▲

      removed the media type image/webp for the response with the status 200

      response-media-type-removed

    • ●

      deleted the query request parameter trim-border

      request-parameter-removed