remove-background

Files (4)

• LICENSE.txt
• SKILL.md
• api-endpoints.md · references/
• bria_client.sh · references/code-examples/

SKILL.md (first lines)

# Remove Background — Transparent PNGs & Cutouts with RMBG 2.0

Remove the background from any image and get a transparent PNG. Powered by Bria's RMBG 2.0 model — commercially safe, royalty-free, production-ready background removal and foreground segmentation.

## When to Use This Skill

Use this skill when the user wants to:
- **Remove a background** — "remove the background", "make the background transparent", "delete the background"
- **Create a transparent PNG** — "give me a PNG with no background", "transparent version", "cutout"
- **Create a cutout** — "cut out the person", "cutout of the product", "photo cutout", "image cutout"
- **Extract the foreground subject** — "isolate the product", "foreground extraction"
- **Keep or drop something specific (guided)** — "remove the background but keep the mat", "without the dog", "only the chair"
- **Product cutout for e-commerce** — "product photo with transparent background", "packshot cutout", "catalog cutout image"
- **Portrait and headshot cutout** — "remove background from headshot", "portrait with no background"
- **Batch background removal** — "remove backgrounds from all these images", "process in bulk"
- **Image segmentation** — "segment the foreground", "separate foreground and background", "foreground segmentation"
- **Prepare cutouts for compositing** — "I need a cutout to paste onto another image", "layer separation"
- **Background eraser** — "erase the background", "background eraser tool", "clean background removal"

### When NOT to Use This Skill

For other image operations, use the **bria-ai** skill instead:
- **Replace** background with a new scene → bria-ai (`replace_background`)
- **Blur** background → bria-ai (`blur_background`)
- **Generate** images from text → bria-ai (`generate`)
- **Edit** images with instructions → bria-ai (`edit`)
- **Pull one named thing out of a scene** ("extract the tree", "extract the car") → bria-ai (`POST /v2/image/edit/extract_object`), not this skill — see Routing below.

This skill does one thing: **remove backgrounds to produce transparent PNGs and cutouts**, including the guided variant that keeps or drops something specific on request.

### Routing: plain, guided, or extract-object

Three different requests sound alike but hit three different routes. "Only the X" can mean either
of the last two — don't route on wording alone. Decide by whether X is part of the **obvious
foreground**: what a plain background-removal call would already keep as the subject.

1. **X is the obvious foreground, or part of it**: the prompt adds to it, drops part of it,
   or narrows down to one piece of it: "remove the background but keep the mat", "without the dog",
   "only the chair" (when the chair is one of the salient subjects a plain cutout would already
   keep) → **guided remove background** (`POST /v2/image/edit/remove_background/guided`, see
   below). Still a full background-removal cutout; the prompt only adjusts what counts as
   foreground.
2. **X is *not* part of the obvious foreground** — a background or peripheral object a plain cutout
   would never have kept on its own: "extract the tree", "only the sign in the background" →
   `POST /v2/image/edit/extract_object` (bria-ai skill, not this one). This pulls one specific,
   named thing out of the scene regardless of what's salient.
3. **Anything else** — "remove the background", "cut out the product", "transparent PNG" → plain
   **remove background** (`POST /v2/image/edit/remove_background`, below).

If a guided call 404s specifically, guided removal is unavailable for the organization right now. See "If the
guided route 404s" below; fall back to plain remove background rather than retrying the guided
route. Any other failure (auth, validation, server error, timeout) is a real error: surface it,
don't treat it as "unavailable."

---

## Setup — Authentication

Before making any API call, you need a valid Bria access token.

### Step 1: Check for existing credentials

```bash
if [ -f ~/.bria/credentials ]; then
  BRIA_ACCESS_TOKEN=$(grep '^access_token=' "$HOME/.bria/credentials" | cut -d= -f2-)
  BRIA_API_KEY=$(grep '^api_token=' "$HOME/.bria/credentials" | cut -d= -f2-)
fi
if [ -z "$BRIA_ACCESS_TOKEN" ]; then
  echo "NO_CREDENTIALS"
elif [ -n "$BRIA_API_KEY" ]; then
  echo "READY"
else
  echo "CREDENTIALS_FOUND"
fi
```

If the output is `READY`, skip straight to making API calls — no introspection needed.
If the output is `CREDENTIALS_FOUND`, skip to Step 3.
If the output is `NO_CREDENTIALS`, proceed to Step 2.

### Step 2: Authenticate via device authorization

Start the device authorization flow:

**2a. Request a device code:**

```bash
DEVICE_RESPONSE=$(curl -s -X POST "https://engine.prod.bria-api.com/v2/auth/device/authorize" \
  -H "Content-Type: application/json")
echo "$DEVICE_RESPONSE"
```

Parse the response fields:
- `device_code` — used to poll for the token (keep this, don't show to user)
- `user_code` — the code the user must enter (e.g. `BRIA-XXXX`)
- `interval` — seconds between poll attempts

**2b. Show the user a single sign-in link.** Tell them exactly this — nothing more:

> **Connect your Bria account:** [Click here to sign in](https://platform.bria.ai/device/verify?user_code={user_code})
> Your code is **{user_code}** — it's already filled in.

Do NOT show two links. Do NOT show the raw URL separately. Do NOT use `verification_uri` from the API response. Keep it to one clickable link.

**2c. Poll for the token.** After showing the user the code, immediately start polling. Try up to 60 times with the given interval (default 5 seconds):

```bash
for i in $(seq 1 60); do
  TOKEN_RESPONSE=$(curl -s -X POST "https://engine.prod.bria-api.com/v2/auth/token" \
    -d "grant_type=urn:ietf:params:oauth:grant-type:device_code" \
    -d "device_code=$DEVICE_CODE")
  ACCESS_TOKEN=$(printf '%s' "$TOKEN_RESPONSE" | sed -n 's/.*"access_token" *: *"\([^"]*\)".*/\1/p')
  if [ -n "$ACCESS_TOKEN" ]; then
    BRIA_ACCESS_TOKEN="$ACCESS_TOKEN"
    REFRESH_TOKEN=$(printf '%s' "$TOKEN_RESPONSE" | sed -n 's/.*"refresh_token" *: *"\([^"]*\)".*/\1/p')
    mkdir -p ~/.bria
    printf 'access_token=%s\nrefresh_token=%s\n' "$BRIA_ACCESS_TOKEN" "$REFRESH_TOKEN" > "$HOME/.bria/credentials"
    echo "AUTHENTICATED"
    break

From Bria-AI/bria-skill, MIT.

More from Bria-AI/bria-skill