This Utility API lets you generate a thumbnail image from a source image and the dimensions (height and width provided).
This API compresses and resizes the image to create the thumbnail. Image thumbnails can be a valuable tool for optimizing web or mobile applications, improving performance, and enhancing the overall visual experience. Thumbnails can help conserve bandwidth, which can be important for applications that are accessed over limited or slow connections.
input file: output file
|The output file name containing the file.
|The width, in pixels, for the thumbnail.
|The height, in pixels, for the thumbnail.
|If auto_orientation is set to
true, it will enable the API to read the Exif data (if available) and automatically rotate the image based on the orientation information in the Exif metadata, by default it is
|the source image file
The method returns the generated thumbnail in the output file mentioned in the URI.
HTTP Response Codes
The method may return one of the following HTTP status codes:
|The request was successful.
|Required authentication information is either missing or not valid for the resource.
|Invalid input - the image file is corrupt or the width and height attributes are not provided.
|If any unexpected error occurs while processing the request
All requests to ApyHub services need to be authenticated, currently we support
basic authentication mechanisms.
You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.