Client

Endpoints for use by clients that convert images using the Image Proxy.

GET /convert

Resize and add image effects to images programmatically.

resize=80x80 (keeps the aspect ratio)

resize=80x80

resize=130x45&shape=cut

resize=130x45&shape=cut

resize=100x38&retina=true

resize=100x38&retina=true

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

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

resize=160x200&dark=55

resize=160x200&dark=55

  • Parameters
  • Name Description Required Type Example
    source

    The URL of the image to convert. MUST BE URL ENCODED.

    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, 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. Valid values are cut and trimcut.

    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 backed service. Backward compatible with the deprecated Heroku Image Proxy service. Certain automated and unused behaviours have been deprecated, rendering these parameters superfluous. Other parameters have been added, specifically new Image Manager text overlays, as the deprecated text parameter values are not reproducible using Akamai Image Manager. In order to facilitate smooth client transitions, requests using the old text parameters will be temporarily forwarded to the old Heroku Image Proxy service.