Sign in

v1

latestOpenAPI 3.0.22026-07-2610288167.4 KB
Freepik
Proxy

Relight an image

Relight an image using AI. This endpoint accepts a variety of parameters to customize the generated images.

post/proxy/freepik/v1/ai/image-relight

Request body

change_backgroundboolean

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

imagestring required

Base64 or URL of the image to do the relight

interpolate_from_originalboolean

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

light_transfer_strengthinteger

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

preserve_detailsboolean

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

promptstring

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'standard' | 'darker_but_realistic' | 'clean' | 'smooth' | 'brighter' | 'contrasted_n_hdr' | 'just_composition'

Style preset for the relight operation.

transfer_light_from_lightmapstring

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

transfer_light_from_reference_imagestring

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

webhook_urlstring uri

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

Example request

{
  "webhook_url": "https://www.example.com/webhook"
}

Response

OK - The relight process has started

Example response

{
  "data": {
    "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}