Image Filters API
30 atoms
Base tier
About
This Utility API lets you apply filters such as image rotation, brightness adjustments, flipping, or Gaussian blur to enhance the aesthetics of the images.
Image filters can improve the overall quality of an image by reducing noise, sharpening edges, and increasing contrast. This can be used to create artistic effects and alter the mood of an image.
Content creators can apply filters to ensure a professional and polished look. Businesses benefit by ensuring consistency in visual branding and adapting images for various platforms. Graphic designers and photographers find this utility indispensable for quick and precise image adjustments, optimizing their workflow.
Endpoint Selector
Input
Output
API Playground
Documentation
input file: output file
POST
https://api.apyhub.com/processor/image/filter/fileRequest example
Method:
POSTContent Type:
multipart/form-dataQuery Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| output | String | No | The name of the output file, defaults to output.png |
| filter | Integer | Yes | The filter that you want to apply on the image. The available options are given below |
Available options for filter
| Options | Description |
|---|---|
| rotate_45 | This will rotate the image by 45° |
| rotate_90 | This will rotate the image by 90° |
| rotate_135 | This will rotate the image by 135° |
| rotate_180 | This will rotate the image by 180° |
| rotate_225 | This will rotate the image by 225° |
| rotate_270 | This will rotate the image by 270° |
| rotate_315 | This will rotate the image by 315° |
| maximum | This removes negative outlier noise from the image |
| minimum | This removes positive outlier noise from the image |
| brightness_decrease | This decreases the overall brighness of the image |
| brightness_increase | This increases the overall brighness of the image |
| gaussian_blur | This mutes the noise and blur the image |
| flip_vertical | This flips the image vertically |
| flip_horizontal | This flips the image horizontally |
| gamma_0.5 | This reduces the gamma value to 0.5, images becomes darker with high contrast and low brightness |
Request Body
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| image | File | Yes | the source image file |
Sample Response
A successful request returns the generated 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 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 filter attribute is not provided. |
| 500 | If 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-tokenas the header parameter to pass the token. - Use the
Authorizationheader to send the basic authentication credentials.
Error codes
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.