Skip to main content
API Reference for bria/image-edit-replace-background, served by Comfy Router from Bria.

Quick start

Create a key in your Comfy workspace 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/image-edit-replace-background Endpoint: POST https://api.comfy.org/v2/models/bria/image-edit-replace-background

Schema

Input

boolean
When true (default), extra processing of the reference images improves the result.
boolean
When true, forces background detection and removal even if the input image has an alpha channel.
string
required
The image to edit. Supported input types are Base64-encoded string or URL pointing to a publicly accessible image file. Accepted formats JPEG, JPG, PNG, WEBP.
string
The background generation mode, one of “base”, “high_control” (default), or “fast”. Applies only when prompt is provided.
string
A text prompt specifying concepts, styles, or objects to exclude from the generated background.
boolean
When true, the output keeps the original image size. When false (default), the output is scaled to 1MP.
string
A text description of the new background. Provide prompt or ref_images, not both. A hex color code in the prompt (for example, “#FF5733”) produces a solid color background.
boolean
When enabled, applies content moderation to the prompt. Returns 422 if the prompt fails moderation.
object
One reference image or a list of reference images that guide the background generation, each a Base64-encoded string or a URL pointing to a publicly accessible image file. Provide prompt or ref_images, not both.
boolean
When true (default), the prompt is automatically adjusted for optimal generation results.
integer
Seed for deterministic generation. If omitted, a random seed is used.
boolean
When false (default), the request is processed asynchronously. When true, the API holds the connection open until complete. ON COMFY ROUTER that second mode is refused rather than forwarded: Router fixes the return mode before dispatch and polls for the result inside the call, so POST /v2/models/bria/{model} answers 422 invalid_input for any sync this route carries other than false or null (routerForbiddenBodyFields). The synchronous call is still available on this operation’s own /proxy/ route, which is the surface this schema also describes.
boolean
When enabled, applies content moderation to result visual. Returns 422 if the output fails moderation.
Generated from the schema Router serves at GET /v2/models/bria/image-edit-replace-background/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

object
Error object (only present when status is ERROR)
integer
Error code.
string
Additional error details.
string
Error message.
string
Unique identifier for the request.
object
Result object (only present when status is COMPLETED)
string
URL of the generated/edited image.
string
Original prompt.
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.
integer
Seed used for generation.
string
The detailed JSON structured prompt.
string
URL of the generated video.
string
Current status of the request.Possible values: IN_PROGRESS, COMPLETED, ERROR, UNKNOWN

Examples

Input

Output

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

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.