> ## 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.

# Comfy Router でビデオ背景除去を使用する

> Comfy Router を通じて veed/video-background-removal を呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。

`veed/video-background-removal` の API リファレンスです。Comfy Router が Veed から提供します。

**入力:** ビデオ · **出力:** ビデオ

## クイックスタート

[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk` と `npm install @comfyorg/sdk`）を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。

**モデル ID:** `veed/video-background-removal`

**エンドポイント:** `POST https://api.comfy.org/v2/models/veed/video-background-removal`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "veed/video-background-removal",
>         {
>             "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";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> const { data } = await comfy.models.run("veed/video-background-removal", {
>   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 \
>   -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\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/veed/video-background-removal/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができた時点で、このプロセスまたは別のプロセスから収集します。[キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md)では、ステータス、キャンセル、収集について説明します。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライで再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "veed/video-background-removal",
>             {
>                 "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)  # モデル ID と合わせて、別のプロセスに必要なのはこれだけです
>
>         # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # プロバイダー自身のペイロードで、models.run() が返す値と同じです。
>         # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを送出します。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライで再利用します。
> const handle = await comfy.models.submit("veed/video-background-removal", {
>   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); // モデル ID と合わせて、別のプロセスに必要なのはこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信します。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> curl https://api.comfy.org/v2/models/veed/video-background-removal/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. status が COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/veed/video-background-removal/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集します。モデルのネイティブ出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/veed/video-background-removal/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

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

出力エンコード: vp9 (アルファ付きのWebMを1つ) または h264 (RGBビデオとアルファマット)。

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

被写体のエッジの品質を向上させます。

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

被写体が人物でない場合は false に設定します。

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

ソースビデオの公開 http(s) URL。

Router が `GET /v2/models/veed/video-background-removal/openapi.json` で提供するスキーマから生成されています。これはリクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となる同一のドキュメントです。

### 出力

**data** `object`

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

ジョブに対して VEED が請求したクレジット。ジョブが COMPLETED になると含まれます。

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

ジョブ実行前に VEED が見積もったクレジット。送信レスポンスにのみ含まれます。

**data.error** `object`

失敗情報。ジョブが FAILED になると含まれます。

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

機械可読な失敗コード。

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

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

人間可読な失敗メッセージ。

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

ステータスのポーリングに使用するジョブID。

**data.result** `object`

生成されたメディア。ジョブが COMPLETED になると含まれます。ビデオのルートは `video`、Clean Audio は `audio`、Video Background Removal は `files` を返します。

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

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

ファイルの MIME タイプ。

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

ファイルの名前。

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

ファイルのサイズ (バイト単位)。

形式: `int64`

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

ファイルをダウンロードできる URL。

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

Video Background Removal の出力。`vp9` の場合はアルファ付きの WebM が1つ、`h264` の場合は RGB ビデオとアルファマット。

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

ファイルの MIME タイプ。

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

ファイルの名前。

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

ファイルのサイズ (バイト単位)。

形式: `int64`

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

ファイルをダウンロードできる URL。

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

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

ファイルの MIME タイプ。

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

ファイルの名前。

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

ファイルのサイズ (バイト単位)。

形式: `int64`

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

ファイルをダウンロードできる URL。

**data.status** `string`

ジョブステータス: PROCESSING、COMPLETED、FAILED、CANCELLED。

## 例

### 入力

```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"
}
```

### 出力

```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"
  }
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


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