Remove Background

POSThttps://api.newportai.com/api/async/remove_background

The Remove Background API allows developers to automatically isolate subjects from their backgrounds. This service identifies the primary subject of an image and removes the surrounding environment to create a transparent or clean output.

  • Submit a POST request to the Remove Background API to obtain a taskId.
  • Submit a POST request to the Polling API to retrieve the background removal results.
  • Configure a Callback URL to receive results automatically on completion.

Request Headers

Content-Type string Required

Enum: application/json

Authorization string Required

Bearer authentication token. Example: Bearer {{APIKey}}.

Request Body

url string Required

The URL of the source image. Constraints: maximum resolution of 16 megapixels and a maximum file size of 10MB.

Response

code integer

Returns 0 for success, or a specific error code.

message string

Returns "success" or a descriptive error message.

data object
taskId string

The unique identifier for the task. Use this ID with the Polling API to retrieve the generated output.

Errors

10192Illegal param

Polling

Use the Polling API to retrieve the processing results.

Callback

Alternatively, you can enable Callback to receive task results automatically upon completion.

0Task Completed
{
  "code": 0,
  "message": "success",
  "data": {
    "task": {
      "taskId": "b08337dc08d7428daa64b3d5e61b8350",
      "status": 3,
      "taskType": "remove_background"
    },
    "images": [
      {
        "imageType": "png",
        "imageUrl": "https://dreamface-resource-cv.oss-us-east-1.aliyuncs.com/aigc-dreamface-remove-background/2025-04-17/removed-image.png"
      }
    ]
  }
}
Request
cURL
curl -X POST 'https://api.newportai.com/api/async/remove_background' \
  -H "Authorization: Bearer {{key}}" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://d2t5pyzt5qvy2d.cloudfront.net/api/static_resource/prod/default/INj5UrnnrKIzCR1uYBWv0.png"
}'
0Successful
{
  "code": 0,
  "message": "success",
  "data": {
    "taskId": "b08337dc08d7428daa64b3d5e61b8350"
  }
}