▣ IMAGE PROCESSING

Background Remover

What it does

Background Remover removes the background from an image and returns either a PNG file or a signed URL to the processed result. Send a source image by URL or upload it as multipart form data, and choose whether you want a direct download or a link response.

Use POST /url/download or POST /multi-part/download when you want the cut-out image back as binary data. Use POST /url/link or POST /multi-part/link when you prefer a JSON response with a data field containing a URI for the output image. The URL-based endpoints accept image_url; the multipart endpoints accept image as binary input.

This is useful when you need to isolate a product photo, remove a portrait background for an avatar pipeline, or prepare marketing assets for a catalog or template workflow. If your app accepts both remote images and uploaded files, Background Remover fits into either path without changing the output format you request.

▣ ENDPOINT 01 / 04

POST

Remove image background (fetch by URL, download PNG)

https://api.eu.apyverse.com/apyhub/remove-image-background/url/download

QUICKSTART

GUIDE

Quickstart

Download a background-removed image from a source image URL.

curl -X POST "https://api.eu.apyverse.com/apyhub/remove-image-background/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://assets.apyhub.com/samples/background-sample.jpeg"
  }'

What you'll get back

Returns binary image data (string with format: binary) in the response body.

(binary image file)

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Downloads the image found at the provided URL, removes its background, and returns the result as a PNG file download.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Output filename or identifier for the generated download.

Request Body

Parameter	Type	Mandatory	Description
image_url	String	Yes	Source image URL. Format: URI.

Response

Returns a binary file response containing the processed image as a PNG download.

Parameter	Type	Mandatory	Description
—	—	—	Binary file content; no JSON fields are defined in the output schema.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

URL mode for remove-background only. Requires `image_url`.

▣ ENDPOINT 02 / 04

POST

Remove image background (fetch by URL, signed link)

https://api.eu.apyverse.com/apyhub/remove-image-background/url/link

QUICKSTART

GUIDE

Quickstart

Convert an image from a URL by sending its image_url in the JSON body.

curl -X POST "https://api.eu.apyverse.com/apyhub/remove-image-background/url/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"image_url":"https://assets.apyhub.com/samples/background-sample.jpeg"}'

What you'll get back

Returns a JSON object with a data string field containing the output image URI.

{
  "data": "https://..."
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Fetches an image from a source URL, removes its background, and returns the result as a JSON object containing a data URI string.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Optional output identifier for the request.

Request Body

Parameter	Type	Mandatory	Description
image_url	String	Yes	Source image URL. Must be a URI.

Response

Returns a JSON object with a data string field containing a URI for the processed image.

Parameter	Type	Mandatory	Description
data	String	Yes	URI of the processed image.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

URL mode for remove-background only. Requires `image_url`.

▣ ENDPOINT 03 / 04

POST

Remove image background (multipart, download PNG)

https://api.eu.apyverse.com/apyhub/remove-image-background/multi-part/download

QUICKSTART

GUIDE

Quickstart

Upload an image to remove its background and download the result.

curl -X POST "https://api.eu.apyverse.com/apyhub/remove-image-background/multi-part/download?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -F "image=@/path/to/image.png"

What you'll get back

Returns a binary file (string with format: "binary"), which is the processed image. There is no JSON wrapper for this response.

<binary file>

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Removes the background from an input raster image sent as multipart form data and returns the resulting PNG as a binary response.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Output filename or name hint. Example: `my-invite`.

Request Body

Parameter	Type	Mandatory	Description
image	String	Yes	Input raster image. Binary file upload.

Response

Returns a binary response containing the processed image. The output schema is a top-level binary string, so the response body is the PNG file itself.

Parameter	Type	Mandatory	Description
Response body	String	Yes	Binary PNG data.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 04 / 04

POST

Remove image background (multipart, signed URL)

https://api.eu.apyverse.com/apyhub/remove-image-background/multi-part/link

QUICKSTART

GUIDE

Quickstart

Upload an image by link to remove its background.

curl -X POST "https://api.eu.apyverse.com/apyhub/remove-image-background/multi-part/link?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -F "image=@/path/to/image.jpg"

What you'll get back

Returns a JSON object with a data string field containing a URI to the result.

{
  "data": "https://example.com/output.png"
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Uploads an image via multipart form data and returns a JSON object containing a data URI string for the processed result. The request accepts the image file in the body and can also take an optional output query parameter.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Output filename or identifier.

Request Body

Parameter	Type	Mandatory	Description
image	String	Yes	The image file to process. Format: binary.

Response

Returns a JSON object with a data string field containing a URI to the resulting image.

Parameter	Type	Mandatory	Description
data	String	No	A URI string for the processed image result.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.