Skip to content
Image Editing
/
/
Relight Image

Relight Image

Request

Try out this capability in Bria's sandbox

Description

Modify the lighting setup (direction and atmosphere) of an image.

Example:

  • Light Type: "spotlight on subject, keep background settings"
Input ImageOutput Image
Security
api_token
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.

light_directionstring

Direction (e.g., "front", "side", "top-down").

Enum:"front""side""bottom""top-down"
light_typestringrequired

Type (e.g., "sunset", "studio", "neon").

Enum:"midday""blue hour light""low-angle sunlight""sunrise light""spotlight on subject, keep background settings""overcast light""soft overcast daylight lighting""cloud-filtered lighting""fog-diffused lighting""moonlight lighting"
webhook_urlstring, (uri)

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

POST
/relight
from bria_client import BriaSyncClient

client = BriaSyncClient()  # reads BRIA_API_TOKEN

job = client.submit(
    endpoint="image/edit/relight",
    payload={
        "image": "<image>",
        "light_type": "midday",
    },
)
result = client.poll(job, interval=2, timeout=120)
print(result.result.image_url)

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"
}