Skip to main content
Version: V2

Remove background

POST 
/v2/artworks/remove-background

Remove the background from an image and return a new artwork with a transparent background. Handy for product shots, portraits, or any prep work before compositing.

Request​

Body

required

    imageUrl urirequired

    URL of the image to remove the background from.

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

    outputFormat string

    Possible values: [auto, png, webp]

    Default value: auto

    Output image format. auto (the default) uses the server default (webp with high-quality settings); png is lossless; webp is equivalent to auto.

Responses​

Artwork accepted; webhook fires on completion.

Schema

    id uuidrequired
    artworkType stringrequired

    Possible values: [remove_background]

    parameters

    object

    required

    imageUrl uri

    URL of the image to remove the background from.

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

    outputFormat string

    Possible values: [auto, png, webp]

    Default value: auto

    Output image format. auto (the default) uses the server default (webp with high-quality settings); png is lossless; webp is equivalent to auto.

    duration numberrequired
    results string[]required
    status stringrequired

    Possible values: [starting, processing, succeeded, failed, canceled]

    createdAt date-timerequired
Loading...