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

# Use Video Background Removal Fast with Comfy Router

> Call veed/video-background-removal-fast through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `veed/video-background-removal-fast`, served by Comfy Router from Veed.

**Input:** Video · **Output:** Video

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk` and `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `veed/video-background-removal-fast`

**Endpoint:** `POST https://api.comfy.org/v2/models/veed/video-background-removal-fast`

**Wait for the result**

```python Python theme={null}
from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "veed/video-background-removal-fast",
        {
            "output_codec": "vp9",
            "refine_foreground_edges": True,
            "subject_is_person": True,
            "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// The SDK automatically creates an idempotency key and reuses it for automatic retries.
const { data } = await comfy.models.run("veed/video-background-removal-fast", {
  output_codec: "vp9",
  refine_foreground_edges: true,
  subject_is_person: true,
  video_url: "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/veed/video-background-removal-fast \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"output_codec\": \"vp9\", \"refine_foreground_edges\": true, \"subject_is_person\": true, \"video_url\": \"https://static-assets.veed.io/api-examples/bg-v2v-input.mp4\"}"
```

**Queue and collect later**

The same body, sent to `POST https://api.comfy.org/v2/models/veed/video-background-removal-fast/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "veed/video-background-removal-fast",
            {
                "output_codec": "vp9",
                "refine_foreground_edges": True,
                "subject_is_person": True,
                "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
            },
        )
        print("request_id:", handle.request_id)  # with the model ID, all another process needs

        # Poll until the request completes, waiting the Retry-After the server names.
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # The provider's own payload, the same value models.run() returns.
        # A request that failed or was cancelled raises the typed Router error here.
        result = await handle.get()

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
const handle = await comfy.models.submit("veed/video-background-removal-fast", {
  output_codec: "vp9",
  refine_foreground_edges: true,
  subject_is_person: true,
  video_url: "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
});
console.log("requestId:", handle.requestId); // with the model ID, all another process needs

// Poll until the request completes, waiting the Retry-After the server names.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// The same result models.run() returns. A request that failed or was cancelled rejects here.
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/veed/video-background-removal-fast/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"output_codec\": \"vp9\", \"refine_foreground_edges\": true, \"subject_is_person\": true, \"video_url\": \"https://static-assets.veed.io/api-examples/bg-v2v-input.mp4\"}"

# 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/veed/video-background-removal-fast/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
curl https://api.comfy.org/v2/models/veed/video-background-removal-fast/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### Input

**output\_codec** `string` (default: "vp9")

Output encoding: vp9 (one WebM with alpha) or h264 (the RGB video and an alpha matte).

**refine\_foreground\_edges** `boolean` (default: true)

Improves the quality of the subject's edges.

**subject\_is\_person** `boolean` (default: true)

Set to false when the subject is not a person.

**video\_url** `string` *required*

Public http(s) URL of the source video.

Generated from the schema Router serves at `GET /v2/models/veed/video-background-removal-fast/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

**data** `object`

**data.credits\_charged** `integer`

Credits VEED charged for the job. Present once the job is COMPLETED.

**data.credits\_estimated** `integer`

Credits VEED quoted before the job ran. Present only on the submit response.

**data.error** `object`

Failure information. Present once the job has FAILED.

**data.error.code** `string`

Machine-readable failure code.

**data.error.details** `object[]`

**data.error.message** `string`

Human-readable failure message.

**data.job\_id** `string`

Job id used to poll for status.

**data.result** `object`

The produced media. Present once the job is COMPLETED. Video routes answer `video`, Clean Audio answers `audio` and Video Background Removal answers `files`.

**data.result.audio** `object`

**data.result.audio.content\_type** `string`

MIME type of the file.

**data.result.audio.file\_name** `string`

Name of the file.

**data.result.audio.file\_size** `integer`

Size of the file in bytes.

Format: `int64`

**data.result.audio.url** `string`

URL the file can be downloaded from.

**data.result.files** `object[]`

Video Background Removal output. One WebM with alpha for `vp9`, or the RGB video and an alpha matte for `h264`.

**data.result.files\[].content\_type** `string`

MIME type of the file.

**data.result.files\[].file\_name** `string`

Name of the file.

**data.result.files\[].file\_size** `integer`

Size of the file in bytes.

Format: `int64`

**data.result.files\[].url** `string`

URL the file can be downloaded from.

**data.result.video** `object`

**data.result.video.content\_type** `string`

MIME type of the file.

**data.result.video.file\_name** `string`

Name of the file.

**data.result.video.file\_size** `integer`

Size of the file in bytes.

Format: `int64`

**data.result.video.url** `string`

URL the file can be downloaded from.

**data.status** `string`

Job status: PROCESSING, COMPLETED, FAILED or CANCELLED.

## Examples

### Input

```json theme={null}
{
  "output_codec": "vp9",
  "refine_foreground_edges": true,
  "subject_is_person": true,
  "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4"
}
```

### Output

```json theme={null}
{
  "data": {
    "credits_charged": 23,
    "job_id": "2a8065b6-9f4e-4132-bb7f-e99db65726bd",
    "result": {
      "files": [
        {
          "content_type": "application/octet-stream",
          "url": "https://example.invalid/veed/foreground.webm"
        }
      ]
    },
    "status": "COMPLETED"
  }
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](/development/comfy-router/limitations#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](/development/api-development/sdks).

> **[Headers](/development/comfy-router/headers)**
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> **[Using the Router API](/development/comfy-router/api)**
>
> Model discovery, validation errors, retries, and billing.

> **[Limitations](/development/comfy-router/limitations)**
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.