Skip to main content
POST
Relight an image

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
image
string
required

Base64 or URL of the image to do the relight

advanced_settings
object
change_background
boolean
default:true

When enabled, changes the background based on prompt and/or reference image. Useful for product placement and portraits.

interpolate_from_original
boolean
default:false

When enabled, makes the final image interpolate from the original using the light transfer strength slider.

light_transfer_strength
integer
default:100

Level of light transfer intensity. 0% keeps closest to original, 100% is maximum transfer.

Required range: 0 <= x <= 100
preserve_details
boolean
default:true

Maintains texture and small details of the original image. Good for product photography, texts, etc.

prompt
string

You can guide the generation process and influence the light transfer with a descriptive prompt. IMPORTANT: You can emphasize specific aspects of the light in your prompt by using a number in parentheses, ranging from 1 to 1.4, like "(dark scene:1.3)".

style
enum<string>
default:standard

Style preset for the relight operation.

Available options:
standard,
darker_but_realistic,
clean,
smooth,
brighter,
contrasted_n_hdr,
just_composition
transfer_light_from_lightmap
string

Base64 or URL of the lightmap for light transfer. Incompatible with 'transfer_light_from_reference_image'

transfer_light_from_reference_image
string

Base64 or URL of the reference image for light transfer. Incompatible with 'transfer_light_from_lightmap'

webhook_url
string<uri>

Optional callback URL that will receive asynchronous notifications whenever the task changes status.

Example:

"https://www.example.com/webhook"

Response

OK - The relight process has started

data
object
required