> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-matt-sdk-0-3-0-run-kind.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Video Edit Green Screen with Comfy Router

> Call bria/video-edit-green-screen through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `bria/video-edit-green-screen`, served by Comfy Router from Bria.

## Quick start

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

**Model ID:** `bria/video-edit-green-screen`

**Endpoint:** `POST https://api.comfy.org/v2/models/bria/video-edit-green-screen`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```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(
              "bria/video-edit-green-screen",
              {
                  "green_shade": "broadcast_green",
                  "video": "https://example.com/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("bria/video-edit-green-screen", {
        green_shade: "broadcast_green",
        video: "https://example.com/input.mp4",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/bria/video-edit-green-screen \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"green_shade\": \"broadcast_green\", \"video\": \"https://example.com/input.mp4\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <Note>
      Queued delivery is rolling out per workspace. Until yours is enabled, the submit route answers `403` with `X-Comfy-Error-Type: not_enabled`. Nothing about the request is wrong, and the same body works through the synchronous route in the meantime.
    </Note>

    The same body, sent to `POST https://api.comfy.org/v2/models/bria/video-edit-green-screen/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.

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

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "bria/video-edit-green-screen",
              {
                  "green_shade": "broadcast_green",
                  "video": "https://example.com/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.
          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 = handle.get()

      print(result)
      ```

      ```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("bria/video-edit-green-screen", {
        green_shade: "broadcast_green",
        video: "https://example.com/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/bria/video-edit-green-screen/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"green_shade\": \"broadcast_green\", \"video\": \"https://example.com/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/bria/video-edit-green-screen/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/bria/video-edit-green-screen/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="green_shade" type="string">
  The solid background shade applied behind the foreground for chroma keying. Defaults to broadcast\_green.

  Possible values: `broadcast_green`, `chroma_green`, `blue_screen`
</ParamField>

<ParamField body="output_container_and_codec" type="string">
  Output container and codec preset.

  Possible values: `mp4_h264`, `mp4_h265`, `webm_vp9`, `mov_h265`, `mov_proresks`, `mkv_h264`, `mkv_h265`, `mkv_vp9`, `gif`
</ParamField>

<ParamField body="preserve_audio" type="boolean">
  Whether to preserve audio from the input video.
</ParamField>

<ParamField body="video" type="string" required>
  Publicly accessible URL of the input video. Input resolution supported up to 16000x16000 (16K). Max duration 60 seconds.
</ParamField>

Generated from the schema Router serves at `GET /v2/models/bria/video-edit-green-screen/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

<ResponseField name="error" type="object">
  Error object (only present when status is ERROR)
</ResponseField>

<ResponseField name="error.code" type="integer">
  Error code.
</ResponseField>

<ResponseField name="error.details" type="string">
  Additional error details.
</ResponseField>

<ResponseField name="error.message" type="string">
  Error message.
</ResponseField>

<ResponseField name="request_id" type="string">
  Unique identifier for the request.
</ResponseField>

<ResponseField name="result" type="object">
  Result object (only present when status is COMPLETED)
</ResponseField>

<ResponseField name="result.image_url" type="string">
  URL of the generated/edited image.
</ResponseField>

<ResponseField name="result.prompt" type="string">
  Original prompt.
</ResponseField>

<ResponseField name="result.refined_prompt" type="string">
  Refined version of the prompt, or null on a COMPLETED generation Bria did not refine. Nullable because the key is PRESENT carrying null rather than omitted; observed live on bria/image-edit-gen-fill.
</ResponseField>

<ResponseField name="result.seed" type="integer">
  Seed used for generation.
</ResponseField>

<ResponseField name="result.structured_prompt" type="string">
  The detailed JSON structured prompt.
</ResponseField>

<ResponseField name="result.video_url" type="string">
  URL of the generated video.
</ResponseField>

<ResponseField name="status" type="string">
  Current status of the request.

  Possible values: `IN_PROGRESS`, `COMPLETED`, `ERROR`, `UNKNOWN`
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "green_shade": "broadcast_green",
  "video": "https://example.com/input.mp4"
}
```

### Output

```json theme={null}
{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "video_url": "https://example.invalid/bria/video-edit-green-screen/generated.mp4"
  },
  "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. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>