v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Generate dynamic asset transformation

Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it. More information about this feature can be found in our Knowledge Base item. Image operations can be passed as io parameters in the form of transform:{operation},{param1}:{value1},{param2}:{value2},.... It's possible to specify several operations: ?io={operation1}&io={operation2}&.... The operations will be applied in the same order they are passed in the url. These are the possible image operations and their parameters: | Operation | Parameter | Possible values | | ------------ | --------------- | ------------------------------------------------------------------------------------ | | background | color | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) | | crop | width | integer | | | height | integer | | | x | integer | | | y | integer | | | gravity | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright | | | shape | circle / square | | | blur | integer | | | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) | | extend | width | integer | | | height | integer | | | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) | | fill | width | integer | | | height | integer | | | gravity | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright | | | aspectratio | {integer}x{integer} | | fit | width | integer | | | height | integer | | flip | (no parameters) | | | mirror | (no parameters) | | | rotate | angle | integer between 0 and 360 | | | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) | | scale | width | integer | | | height | integer |

get/transform/{id}/{name}

Path parameters

idstring required
namestring required

Query parameters

iostring[]

The operation(s) performed on the image before it's served to the client.

focuspointstring

Focus point as a x,y coordinate (with values between 0 - 1).

formatstring

Format of the served image. This can either be jpg or png and it will overwrite the default webP.

qualityinteger

Image quality, ranging from 1 - 100 (has no effect when format is set to 'png').

Response

Image