Editing

Replace Object by Text

Changed on

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"

<table> <tr> <th style="text-align: center;">Input Image</th> <th style="text-align: center;">Output Image</th> </tr> <tr> <td align="center" style="vertical-align: middle;"> <img src="https://bria-datasets.s3.us-east-1.amazonaws.com/Liza/a_bowl_of_fruits__should_have_a_red_apple.png" width="300" style="border-radius: 8px;"> </td> <td align="center" style="vertical-align: middle;"> <img src="https://bria-datasets.s3.us-east-1.amazonaws.com/Liza/bria_result+(2).png" width="300" style="border-radius: 8px;"> </td> </tr> </table>
post/replace_object_by_text

Request

  • Base URL: https://engine.prod.bria-api.com/v2/image/edit
  • URL: https://engine.prod.bria-api.com/v2/image/edit/replace_object_by_text
  • Auth: API key in header api_token

Request body

imagestring required

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.

instructionstring required

Natural language command.

webhook_urlstring uri

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

Response

Successful operation (Synchronous Success)

request_idstring required
warningstring

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

Changes

  • 1d2fc668005fRevision changes
    • warning

      deleted the header request parameter api_token

    • info

      api tag Editing added

    • info

      api tag v2 endpoints removed