This API empowers you to seamlessly replace backgrounds in images of any format.
The ability to alter image backgrounds is widely employed in diverse fields such as e-commerce, where it enhances product images, portrait photography for professional isolation, and graphic design. Additionally, it's a critical tool in filmmaking for achieving visual effects and web design to create effective images.
Upon a successful request, you'll receive the modified image with the new background. In case of an unsuccessful request, the response will include an error code and a descriptive message to assist you in diagnosing and resolving the issue.
input file: output file
|output||String||No||The output file name for the image.|
|image||File||Yes||the source image file|
|background_color||String||Yes (if background_image not given)||the background color for the image, should be in hexadecimal color|
|background_image||File||Yes (if background_color not given)||the path of background image file which should be accessible by ApyHub. If background_color and background_image both are present in the request then background_color will be applied.|
|image_position||String||No||the image position. For example: you want to add the image at center position then it will be as |
|image_opacity||Number||No||the opacity of the image , should be in |
|background_opacity||Number||No||the opacity of the background image , should be in |
|image_angle||Number||No||the angle at which the front image should rotate, should be in |
|image_size||String||No||the dimensions of the front image file, should be in |
|background_size||String||No||the dimensions of the background image file, should be in |
The method returns the image with changed background in the output file mentioned in the URI.
HTTP Response Codes
The method may return one of the following HTTP status codes:
|200||The request was successful.|
|401||Required authentication information is either missing or not valid for the resource.|
|400||Invalid input - the image files are corrupt.|
|500||If any unexpected error occurs while processing the request.|
All requests to ApyHub services need to be authenticated, currently we support
basic authenticationmechanisms. 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.
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.