Multimodal AI

Background Remover API

Cut out products, people, or clothing from a source image using an upstream background-removal model.

post/api/skill-api/v1/skills/background-remover/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/background-remover/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

imageUrlstring required

Public URL of the image to cut out. The image must be up to 20 MB and between 385 and 8192 pixels in both width and height.

subTypeinteger required

Cutout type. Supported values: 1 (general), 2 (portrait), 3 (product), 9 (apparel), 12 (hair), 13 (face).

clothClassstring

Apparel classes used only when subType is 9. Multiple values may be comma-separated. Supported values: tops, coat, skirt, pants, bag, shoes, hat.

Example request

{
  "imageUrl": "https://example.com/product.jpg",
  "subType": 1
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.