apyhub-logo
API CatalogPricingBlog
Log in

Resize Images API

File Manipulation#images#resize
30 atoms
Base tier

About

This Utility API lets you resize any image image either in png, jpeg or jpg formats.
This API can be useful for optimizing images for a variety of applications, improving performance, and enhancing the overall visual experience. This can reduce the file size, which can be beneficial for web or email applications where smaller file sizes are desirable. Resizing an image can make it compatible with a wider range of devices and applications, such as mobile devices with smaller screens or applications with specific image size requirements.
Select API Endpoints
Input
Output

API Playground

API Documentation

input file: output file
POST
https://api.apyhub.com/processor/image/resize/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/processor/image/resize/file?output=test-sample.png&width=100&height=100&auto_orientation=false' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"stock-photo.jpg"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name of the output file, defaults to output.png.
widthIntegerYesThe width, in pixels, to which you want to resize the image.
heightIntegerYesThe height, in pixels, to which you want to resize the image.
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.
Request Body
AttributeTypeMandatoryDescription
imageFileYesthe source image file
Sample Response
The method returns the resized image 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 height and width 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.