apyhub-logo
30 atoms
Base tier

About

This Utility API lets you compress images in png, jpeg or jpg formats.
You can control the compression quality - a higher value results in increased compression and reduced resolution.
Compressing an image can significantly reduce its file size, which can save storage space on a device or a website's server. This can be particularly useful for websites that host large numbers of images, as it can help to reduce the site's load time. Faster load times and reduced bandwidth usage can improve the user experience for website visitors and app users, leading to higher engagement and satisfaction.
Endpoint Selector
Input
Output

API Playground

Documentation

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

Request example

1
curl --location --request POST 'https://api.apyhub.com/processor/image/compress/file?output=test-sample.png&compression_percentage=90' \
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
compression_percentageIntegerYesThe desired compression percentage for the image. Increasing the compression_percentage results in a higher level of compression. (should be between 1-100)
Request Body
AttributeTypeMandatoryDescription
imageFileYesthe source image file
Sample Response
A successful request returns the compressed file in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

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 quality attribute is 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.