> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Object Removal

> Remove an unwanted object or region from a photo. Mark the area to remove with a black-and-white mask. The model rebuilds the background using surrounding context.

<Info>
  Pricing: **\$0.48/request**. Endpoint: `POST /v1/models/runflow/object-removal/runs`.
</Info>

Remove an unwanted object or region from a photo. Mark the area to remove with a black-and-white mask. The model rebuilds the background using surrounding context.

## Overview

* **Endpoint**: [https://api.runflow.io/v1/models/runflow/object-removal/runs](https://api.runflow.io/v1/models/runflow/object-removal/runs)
* **Model ID**: runflow/object-removal
* **Provider**: Runflow
* **License**: commercial
* **Last Updated**: 2026-05-05

## Pricing

* **Base price**: \$0.48/request
* **Note**: Per image: object removal

# Object Removal API

**Endpoint:** `POST /v1/models/runflow/object-removal/runs`

## Run the model

### Python

```python theme={"dark"}
import requests

response = requests.post(
    "https://api.runflow.io/v1/models/runflow/object-removal/runs",
    headers={"Authorization": "Bearer RUNFLOW_API_KEY"},
    json={
        "input": {
            "zip_url": "https://public.runflow.io/images/models/runflow/object-removal/examples/1/inputs.zip",
            "file_mask": "mask.png",
            "file_input": "photo.png"
        },
        "callback_url": "https://your-server.com/webhook"
    },
)

data = response.json()
print(data)
```

### Node.js

```javascript theme={"dark"}
const response = await fetch(
  "https://api.runflow.io/v1/models/runflow/object-removal/runs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer RUNFLOW_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "input": {
            "zip_url": "https://public.runflow.io/images/models/runflow/object-removal/examples/1/inputs.zip",
            "file_mask": "mask.png",
            "file_input": "photo.png"
        },
        "callback_url": "https://your-server.com/webhook"
    }),
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash theme={"dark"}
curl -X POST https://api.runflow.io/v1/models/runflow/object-removal/runs \
  -H "Authorization: Bearer $RUNFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
    "input": {
        "zip_url": "https://public.runflow.io/images/models/runflow/object-removal/examples/1/inputs.zip",
        "file_mask": "mask.png",
        "file_input": "photo.png"
    },
    "callback_url": "https://your-server.com/webhook"
}
JSON
```

## Request parameters

| Parameter      | Type           | Required | Description                                                 |
| -------------- | -------------- | -------- | ----------------------------------------------------------- |
| `input`        | object         | required | Model input parameters. See "Input schema" below.           |
| `callback_url` | string \| null | optional | Webhook URL - POSTed when the run reaches a terminal state. |
| `metadata`     | object \| null | optional | Arbitrary key-value pairs attached to the run.              |

## Input schema

| Field        | Type   | Required | Allowed values | Description                                                                                                                                                |
| ------------ | ------ | -------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `zip_url`    | file   | required | Any            | URL of a zip archive containing the input photo and mask. Use file\_input + file\_mask to name the files inside.                                           |
| `file_input` | string | required | Any            | Filename inside `zip_url` (e.g. `photo.png` if the zip contains `photo.png`). Frontend should set this to match the inner filename when composing the zip. |
| `file_mask`  | string | required | Any            | Filename of the B\&W mask inside the URL/zip (white = remove, black = keep). Same shape as `file_input` but for the mask file.                             |

## Output schema

| Field           | Type | Description                                                |
| --------------- | ---- | ---------------------------------------------------------- |
| `outputs`       | json | Array of result items, each with at minimum a `url` field. |
| `seed`          | json | Random seed used (null if N/A).                            |
| `timing`        | json | Provider timing breakdown (null if not surfaced).          |
| `nsfw_detected` | json | Provider NSFW flag (null if not surfaced).                 |

## Callback payload

When you provide a `callback_url`, Runflow POSTs to it once the run reaches a terminal state.

| Field          | Type           | Description                                                    |
| -------------- | -------------- | -------------------------------------------------------------- |
| `event`        | string         | Event type: "run.completed", "run.failed", or "run.cancelled". |
| `run_id`       | string         | The unique identifier of the run.                              |
| `status`       | string         | Terminal status: "succeeded", "failed", or "cancelled".        |
| `output`       | object \| null | The run output. Null if the run failed or was cancelled.       |
| `duration_ms`  | number \| null | Total run duration in milliseconds.                            |
| `created_at`   | string \| null | ISO 8601 timestamp when the run was created.                   |
| `completed_at` | string \| null | ISO 8601 timestamp when the run reached terminal state.        |
| `metadata`     | object \| null | The metadata object passed at run creation, if any.            |

* **Retries:** 3 attempts with exponential backoff (1s, 2s). Retries on 5xx / network errors only.
* **Headers:** `Runflow-Request-Id` is always sent. `Runflow-Signature` is sent if a signing secret is configured.

## Additional Resources

* [Playground](https://app.runflow.io/models/runflow/object-removal)
* [API Reference](https://app.runflow.io/models/runflow/object-removal?tab=api)
* [Documentation](https://docs.runflow.io)
* [OpenAPI](https://docs.runflow.io/api/openapi.public.json)

## Related

<CardGroup cols={2}>
  <Card title="Browse all models" icon="grid" href="/models">Browse the catalog.</Card>
  <Card title="Run lifecycle" icon="play" href="/concepts/runs">Callbacks, polling, statuses.</Card>
  <Card title="Callbacks" icon="webhook" href="/concepts/callbacks">Handle async results.</Card>
  <Card title="Pricing" icon="coin" href="/concepts/pricing">How requests bill out.</Card>
</CardGroup>