Client

Endpoints that convert images and makes request based optimizations.

GET /convert

resize=150x50

resize=x50

resize=150x1000

resize=x200

resize=70x100&shape=cut

resize=80x&retina=true&blur=2.5

resize=160&dark=55

gravity=sw&resize=100x100&shape=cut

gravity=ne&mask=circle&resize=100&shape=cut

  • Parameters
  • Name Description Required Type Example
    source

    The encoded URL of the image to convert. Must be whitelisted.

    Required string http%3A%2F%2Fexample.com%2Fimage.jpg
    resize

    The new size of the image, in “WxH” format. Max limit for both width and height is 5000. Width or height can be omitted (“W”, “Wx” or “xH”) and defaults to 5000.

    string 100x50
    retina

    If the image should be doubled in size, i.e. “(W*2)x(H*2)“.

    boolean true
    shape

    The image cropping behavior. Defaults to keeping proportions. Only valid value is cut

    string cut
    gravity

    Which part of the image to crop. Defaults to center. Valid values are nw to se.

    string nw
    blur

    How much the image should be blurred. Valid values are 0.0-50.0+.

    float 2.3
    dark

    How much darkness to overlay. Valid values are 0-99.

    float 20
    mask

    Mask the image. Only valid value is circle. Shape=cut is recommended unless the pristine image is quadratic.

    string circle

Info

Akamai Image Manager (IM) backed service using a custom API, devoid of Akamai specifics. The purpose of a decoupled implementation is to provide portability. The API also provides backwards compatibility with the now deprecated Heroku Image Proxy service. The current implementation transforms the incoming URL parameters to an imquery that is passed on to the default IM policy. All configuration is made in a single property and policy, as the previous solution of having multiple policies (instead of using a single policy with imquery enabled) proved unnecessarily cumbersome.