## Basic model info

- Model name: bria/bria bria-remove-background
- Model description: Bria RMBG 2.0 enables seamless removal of backgrounds from images, ideal for professional editing tasks.
- Endpoint name: video


## Model schema

The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/bria/bria-remove-background/latest.json)

### Model input schema

The model input schema is:



```json
{
  "properties": {
    "background_color": {
      "anyOf": [
        {
          "enum": [
            "Transparent",
            "Black",
            "White",
            "Gray",
            "Red",
            "Green",
            "Blue",
            "Yellow",
            "Cyan",
            "Magenta",
            "Orange"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Background color to use after removal.",
      "title": "Background Color",
      "x-sr-order": 401
    },
    "output_container_and_codec": {
      "anyOf": [
        {
          "enum": [
            "mp4_h265",
            "mp4_h264",
            "webm_vp9",
            "mov_h265",
            "mov_proresks",
            "mkv_h265",
            "mkv_h264",
            "mkv_vp9",
            "gif"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Output container and codec format.",
      "title": "Output Format",
      "x-sr-order": 402
    },
    "video": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "Input video to remove background from. Size should be less than 4000x4000 and duration less than 30s.",
      "title": "Video",
      "x-sr-order": 301
    }
  },
  "required": [
    "video"
  ],
  "title": "VideoBackgroundRemoveInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



```json
{
  "anyOf": [
    {
      "properties": {
        "image": {
          "properties": {
            "content_type": {
              "description": "The mime type of the file.",
              "title": "Content Type",
              "type": "string"
            },
            "file_name": {
              "description": "The name of the file. It will be auto-generated if not provided.",
              "title": "File Name",
              "type": "string"
            },
            "file_size": {
              "description": "The size of the file in bytes.",
              "title": "File Size",
              "type": "integer"
            },
            "url": {
              "description": "The URL where the file can be downloaded from.",
              "title": "Url",
              "type": "string"
            }
          },
          "required": [
            "content_type",
            "file_name",
            "file_size",
            "url"
          ],
          "title": "SunraFile",
          "type": "object"
        }
      },
      "required": [
        "image"
      ],
      "title": "ImageOutput",
      "type": "object"
    },
    {
      "properties": {
        "input_video_dur": {
          "description": "Duration of the input video in seconds (rounded)",
          "title": "Input Video Dur",
          "type": "integer"
        },
        "video": {
          "properties": {
            "content_type": {
              "description": "The mime type of the file.",
              "title": "Content Type",
              "type": "string"
            },
            "file_name": {
              "description": "The name of the file. It will be auto-generated if not provided.",
              "title": "File Name",
              "type": "string"
            },
            "file_size": {
              "description": "The size of the file in bytes.",
              "title": "File Size",
              "type": "integer"
            },
            "url": {
              "description": "The URL where the file can be downloaded from.",
              "title": "Url",
              "type": "string"
            }
          },
          "required": [
            "content_type",
            "file_name",
            "file_size",
            "url"
          ],
          "title": "SunraFile",
          "type": "object"
        }
      },
      "required": [
        "video",
        "input_video_dur"
      ],
      "title": "VideoBackgroundRemoveOutput",
      "type": "object"
    }
  ],
  "title": "Response Get Request Result Requests  Request Id  Get"
}
```



## Example inputs and outputs

Use the following example inputs and outputs to understand the model.

### Input example



```json
{
  "background_color": null,
  "output_container_and_codec": null,
  "video": ""
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



```javascript
import { sunra } from "@sunra/client";

const result = await sunra.subscribe("bria/bria-remove-background/video", {
  input: {
  	video: '',
  	background_color: null,
  	output_container_and_codec: null
  },
  logs: true,
  onQueueUpdate: (update) => {
    console.log(`Status Update: ${update.status}, Request ID: ${update.request_id}`);
  },
});
console.log(result.data);
console.log(result.requestId);
```



### Python



```python
import sunra_client

result = sunra_client.subscribe(
    "bria/bria-remove-background/video",
    arguments={
        "video": "",
        "background_color": None,
        "output_container_and_codec": None
    },
    with_logs=True,
    on_enqueue=print,
    on_queue_update=print,
)
print(result)
```



### Java



```java
import ai.sunra.client.*;
import java.util.Map;
import com.google.gson.JsonObject;

var client = SunraClient.withEnvCredentials();

var response = client.subscribe(
    "bria/bria-remove-background/video",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "video", "",
            "background_color", null,
            "output_container_and_codec", null))
        .resultType(JsonObject.class)
        .onQueueUpdate(update -> System.out.printf(
            "\nStatus Update: %s, Request ID: %s%n",
            update.getStatus(),
            update.getRequestId()
        ))
        .logs(true)
        .build()
);

System.out.println("Completed!");
System.out.println(response.getData());
  
```



### Kotlin



```kotlin
import ai.sunra.client.kt.*
import com.google.gson.JsonObject

val client = createSunraClient()

val response = client.subscribe<JsonObject>(
    endpointId = "bria/bria-remove-background/video",
    input = mapOf(
            "video" to "",
            "background_color" to null,
            "output_container_and_codec" to null),
    options = ai.sunra.client.kt.SubscribeOptions(logs = true),
    onUpdate = { update ->
        println("\nStatus Update: ${update.status}, Request ID: ${update.requestId}")
    }
)

println("Completed!")
println(response.data)
  
```



### Curl



```bash

curl --request POST \
  --url https://api.sunra.ai/v1/queue/bria/bria-remove-background/video \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"video":"","background_color":null,"output_container_and_codec":null}'
    
```



## Model readme

undefined