Replace Object by Text

Image Editing

Request

Try out this capability in Bria's sandbox Description

Swap an existing object in an image with a new one using a natural language command.

Example: Instruction: "Replace the red apple with a green pear"

Input Image	Output Image

Headers

api_tokenstringrequired

Bodyapplication/json

imagestringrequired

The source image to be handled by the API.
Supported input types:

Base64-encoded string - URL pointing to an image file that is publicly accessible and available at the time of processing.

Accepted formats: JPEG, JPG, PNG, WEBP.

instructionstringrequired

Natural language command.

webhook_urlstring, (uri)

Optional URL for receiving the result via webhook when the async job completes. See Webhooks.

POST

/replace_object_by_text

curl -i -X POST \
  https://engine.prod.bria-api.com/v2/image/edit/replace_object_by_text \
  -H 'Content-Type: application/json' \
  -H 'api_token: string' \
  -d '{
    "image": "string",
    "instruction": "string",
    "webhook_url": "http://example.com"
  }'

Responses

Successful operation (Synchronous Success)

Bodyapplication/json

resultobjectrequired

request_idstringrequired

warningstring

Returned only when ip_signal = true and the instruction field included IP content.

Response

{
  "result": {
    "image_url": "string",
    "seed": 0,
    "structured_instruction": "string"
  },
  "request_id": "string",
  "warning": "string"
}