Background Removal API
Get API Key
Easy to integrate
Our API is a simple HTTP interface with various options:
- Source images: Direct uploads or URL reference
- Result images: Image file or JSON-encoded data
- Output resolution: Up to 25 megapixels
- Requires images that have a foreground
Get started
-
Get your API key.
- Use the following code samples to get started quickly
- Review the reference docs to adjust any parameters
Request description
HTTP method: POST Request URL:
https://www.cutout.pro/api/v1/matting
Header parameters:
| parameter | value |
|---|---|
| Content-Type | multipart/form-data |
| APIKEY | Your Exclusive API Key |
Query string parameters:
| parameter | value | required |
|---|---|---|
| mattingType | 1: Remove Background; 3: Avatar Matting |
TRUE |
| crop | true: Crop the image to fix the non-transparent areas; false: no crop |
FALSE |
Multipart body parameters:
| parameter | value |
|---|---|
| file | Picture file |
Responses
-
Normal response
Output binary format of processed image, content-type is image/png
-
Abnormal response
Output application/json format strings
{
"code": 1001,
"data": null,
"msg": 'Request failed',
"time": 1590462453264,
}
| Error Code | Description |
|---|---|
| 1001 | Request failed |
| 1002 | File size must be less than 10M |
| 4001 | Your credits is not enough |
| 4002 | File not exist |
| 5002 | Invalid api key |
| 5003 | Matting failed |
| 5004 | Image url download failed |
| 5005 | Query per second limited |
| 5006 | Invalid base64 string |
| 5007 | Base64 string can not be recognized as image |
| 5008 | Input image can not be recognized as image |
| 7001 | Face analysis failed |
| 7002 | Multiple person detected |
Request restrictions
The current API QPS limit is 3 query / second
Product Pricing
You can purchase the number of API calls through online recharge and payment methods. Each successful API call costs 1 credit.
View the price list