v2

latestSwagger 2.0raw.githubusercontent.com2019-08-2693365.9 KB

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

post/generateThumbnail

Query parameters

widthinteger required

Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

heightinteger required

Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

smartCroppingboolean

Boolean flag for enabling smart cropping.

Request body

urlstring required

Publicly reachable URL of an image.

Response

The generated thumbnail in binary format.