png
, jpeg
, jpg
, bmp
, tiff
, gif
or webp
formats.https://api.apyhub.com/processor/image/crop/file
POST
multipart/form-data
Attribute | Type | Mandatory | Description |
---|---|---|---|
output | String | No | The name of the output file, defaults to output.png |
preserve_format | Boolean | No | To preserve the format of the output image file, set it to true . The default is false , which returns a jpeg image. |
Attribute | Type | Mandatory | Description |
---|---|---|---|
image | File | Yes | The source image file in supported formats such as png , jpeg , jpg , bmp , tiff , gif , or webp . |
top | string | No | The 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. |
bottom | string | No | The 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. |
left | string | No | The 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. |
right | string | No | The 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. |
Status Code | Description |
---|---|
200 | The request was successful. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - the image file is corrupt or the height and width are not provided. |
500 | If any unexpected error occurs while processing the request. |
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".apy-token
as the header parameter to pass the token.Authorization
header to send the basic authentication credentials.