Image Thumbnail API - ApyHub - ApyHub

Generate Image Thumbnails API

E-commerce Quick ToolsFile ManipulationImage ProcessingSmart Generation#images#resize#thumbnail
ApyHub
ApyHub
verified icon
30 atoms
Base tier

About

This API lets you generate a thumbnail image from a source image in any dimensions (height and width) by compressing and resizing the image. The API accepts input images in multiple formats including PNG, JPEG, JPG, BMP, TIFF, GIF or WebP.
The API can help optimize images for web or mobile applications for faster loading, improving performance, and enhancing the overall visual experience. Generating Thumbnails through an API can help you and your application conserve bandwidth, which can be important for applications that are accessed over limited or slow connections.
Try out the API in the API playground and see how this free online Image thumbnail generator API can help you generate and optimize image thumbnails, save time and reduce image editing errors through a simple API call.
Select API Endpoints
Input
Output

API Playground

API Documentation

input file: output file
POST
https://api.apyhub.com/generate/image/thumbnail/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/image/thumbnail/file?output=thumbnail&width=100&height=100&auto_orientation=false&preserve_format=true' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"test.png"' \
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe output file name containing the file.
widthIntegerYesThe width, in pixels, for the thumbnail.
heightIntegerYesThe height, in pixels, for the thumbnail.
auto_orientationBooleanNoIf 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 false.
preserve_formatBooleanNoTo preserve the format of the output image file, set it to true. The default is false, which returns a jpeg image.
Request Body
AttributeTypeMandatoryDescription
imageFileYesThe source image file in supported formats such as png, jpeg, jpg, bmp, tiff, gif, or webp.
Sample Response
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:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the image file is corrupt or the width and height attributes are not provided.
500If any unexpected error occurs while processing the request

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
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-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
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.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles