apyhub-logo

Remove Background from Images API

1000 atoms
Premium tier

About

This API lets you accurately remove backgrounds from images. The API accepts input images in multiple formats including WebP, JPG, JPEG, PNG, BMP, GIF, and TIFF.
Try out the API in the API playground and see how this free Background Remover API can help you improve your image editing process and workflows with a simple API call.
Select API Endpoints
Input
Output

API Playground

API Documentation

input file: output file
POST
https://api.apyhub.com/processor/image/remove-background/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/processor/image/remove-background/file?output=test-sample.png' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"stock-photo.jpg"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe output file name for the image.
Request Body
AttributeTypeMandatoryDescription
imageFileYesthe source image file
Sample Response
The method returns the image without a background 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 files are corrupt.
500If any unexpected error occurs while processing the request.

Authentication

All API 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 your workspace settings (on the left side of the navbar) and go to “API Keys".
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.