## Basic model info

- Model name: bria/bria guided-remove-background
- Model description: Bria background removal you steer with a prompt: starts from the same clean cut as Bria RMBG, then adds, drops or isolates objects from plain words like 'the person with the mat and the plant' or 'only the chair'. Original pixels, real alpha, nothing repainted. $0.03 per image.
- Endpoint name: image


## Model schema

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

### Model input schema

The model input schema is:



```json
{
  "description": "Input schema for Bria Guided Remove Background.",
  "properties": {
    "prompt": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Plain words that adjust the default cutout of the photo's obvious subject: add something ('the person with the mat and the plant'), drop something ('the person without the bag') or isolate something ('only the chair'). Omit it for the standard foreground cutout.",
      "title": "Prompt",
      "x-sr-order": 201
    },
    "autocrop": {
      "default": false,
      "description": "Tighten the output canvas to the kept content.",
      "title": "Autocrop",
      "type": "boolean",
      "x-sr-order": 401
    },
    "image": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "Source image to cut out (public URL).",
      "title": "Image",
      "x-sr-order": 301
    }
  },
  "required": [
    "image"
  ],
  "title": "ImageInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



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



## Example inputs and outputs

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

### Input example



```json
{
  "prompt": null,
  "autocrop": false,
  "image": ""
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



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

const result = await sunra.subscribe("bria/guided-remove-background/image", {
  input: {
  	prompt: null,
  	image: '',
  	autocrop: false
  },
  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/guided-remove-background/image",
    arguments={
        "prompt": None,
        "image": "",
        "autocrop": False
    },

    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/guided-remove-background/image",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "prompt", null,
            "image", "",
            "autocrop", false))

        .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/guided-remove-background/image",
    input = mapOf(
            "prompt" to null,
            "image" to "",
            "autocrop" to false),
    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/guided-remove-background/image \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"prompt":null,"image":"","autocrop":false}'
    
```



## Model readme

>