apyhub-logo
30 atoms
Base tier

About

This Utility API lets you crop images either in png, jpeg or jpg formats.
Cropping an image can improve its overall composition by removing distracting or irrelevant elements and focusing on the main subject.
This provides several other benefits like improved composition, adjusting aspect ratio, highlighting details, removing unwanted content, and saving storage space. It can be used to improve the visual impact of an image, make it more effective for a particular purpose, or reduce its file size.
Endpoint Selector
Input
Output

API Playground

Documentation

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

Request example

1
curl --location --request POST 'https://api.apyhub.com/processor/image/crop/file?output=test-sample.png' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"stock-photo.jpg"'
4
--form 'top="30px"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name of the output file, defaults to output.png
Request Body
AttributeTypeMandatoryDescription
imageFileYesthe source image file
topstringNoThe desired top margin for cropping can be specified either in pixels, like 10px, or as a percentage, such as 10%or simple10. By default, it assumes that the value is provided as a percentage.
bottomstringNoThe desired bottom margin for cropping can be specified either in pixels, like 10px, or as a percentage, such as 10%or simple10. By default, it assumes that the value is provided as a percentage.
leftstringNoThe desired left margin for cropping can be specified either in pixels, like 10px, or as a percentage, such as 10%or simple10. By default, it assumes that the value is provided as a percentage.
rightstringNoThe desired right margin for cropping can be specified either in pixels, like 10px, or as a percentage, such as 10%or simple10. By default, it assumes that the value is provided as a percentage.
Please note that at least one value for either the top, bottom, left, or right margin must be provided.
Sample Response
The method returns the cropped 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 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 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-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.