Quickstart

1. Get access

Subscribe to the listing for your endpoint. Your marketplace provides credentials and billing.

2. Set your credentials

Set RAPIDAPI_KEY or APY_TOKEN on your server. Python examples require httpx; Node.js examples use built-in fetch.

python -m pip install httpx

export RAPIDAPI_KEY="YOUR_RAPIDAPI_KEY"
# or
export APY_TOKEN="YOUR_APYHUB_TOKEN"

3. Send a request

Replace the base64 placeholder with your file’s bytes. The tutorial includes a complete upload example.

import os
import httpx

base_url = "https://background-removal-api-cutouts-masks.p.rapidapi.com"
headers = {
    "X-RapidAPI-Key": os.environ["RAPIDAPI_KEY"],
    "X-RapidAPI-Host": "background-removal-api-cutouts-masks.p.rapidapi.com",
}
payload = {
    "format": "png",
    "max_size": 900,
    "image": {
        "base64": "BASE64_IMAGE",
    },
}
response = httpx.post(
    base_url + "/v1/background/remove",
    headers=headers, json=payload, timeout=120
)
response.raise_for_status()
with open("result.png", "wb") as output:
    output.write(response.content)

4. Check the result

Check the status and Content-Type before saving the returned file.

Live cutout and mask demos have a maximum 900 px long edge. Fine hair, translucent objects and low-contrast edges may need editing. Review the cutout before publishing.

Errors and retries

• 401 / 403: check your credentials, subscription and feature access.
• 422: correct the input before retrying. Application errors include a detail object with a code and message.
• 429: check your rate limit or plan allowance.
• 502 / 503 / 504: use bounded retries with backoff and honor Retry-After. Retries may consume allowance.

Marketplace errors may use a different format. Keep the status and request identifier for diagnostics; avoid logging API keys or customer files.