Skip to main content
API Reference for freepik/ai-image-relight, served by Comfy Router from Freepik. Input: Text, Image · Output: Image

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk and npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: freepik/ai-image-relight Endpoint: POST https://api.comfy.org/v2/models/freepik/ai-image-relight
The same body, sent to POST https://api.comfy.org/v2/models/freepik/ai-image-relight/requests. Router answers 201 with a request_id as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. Queued delivery walks through status, cancellation and collection.

Schema

Input

object
integer
default:"50"
Adjust the level of black color in the image.Range: 0 to 100
integer
default:"50"
Adjust the level of brightness in the image.Range: 0 to 100
integer
default:"50"
Adjust the level of contrast in the image.Range: 0 to 100
string
default:"\"automatic\""
Engine preset for relighting:
  • balanced: Well-rounded, general-purpose option
  • cool: Brighter with cooler tones
  • real: Aims to enhance photographic quality (Experimental)
  • illusio: Optimized for illustrations and drawings
  • fairy: Suited for fantasy-themed images
  • colorful_anime: Ideal for anime, cartoons, and vibrant colors
  • hard_transform: Significantly alters the original image
  • softy: Slightly softer effect, suitable for graphic designs Possible values: automatic, balanced, cool, real, illusio, fairy, colorful_anime, hard_transform, softy
boolean
default:"false"
When enabled, using the same settings will consistently produce the same image.
integer
default:"50"
Adjust the level of saturation in the image.Range: 0 to 100
string
default:"\"automatic\""
Adjusts the intensity of light transfer.Possible values: automatic, low, medium, normal, high, high_on_faces
string
default:"\"automatic\""
Also modifies light transfer intensity. Can be combined with transfer_light_a for varied effects.Possible values: automatic, composition, straight, smooth_in, smooth_out, smooth_both, reverse_both, soft_in, soft_out, soft_mid, strong_mid, style_shift, strong_shift
integer
default:"50"
Adjust the level of white color in the image.Range: 0 to 100
boolean
default:"true"
When enabled, changes the background based on prompt and/or reference image. Useful for product placement and portraits.
string
required
Base64 or URL of the image to do the relight
boolean
default:"false"
When enabled, makes the final image interpolate from the original using the light transfer strength slider.
integer
default:"100"
Level of light transfer intensity. 0% keeps closest to original, 100% is maximum transfer.Range: 0 to 100
boolean
default:"true"
Maintains texture and small details of the original image. Good for product photography, texts, etc.
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)”.
string
default:"\"standard\""
Style preset for the relight operation.Possible values: standard, darker_but_realistic, clean, smooth, brighter, contrasted_n_hdr, just_composition
string
Base64 or URL of the lightmap for light transfer. Incompatible with ‘transfer_light_from_reference_image’
string
Base64 or URL of the reference image for light transfer. Incompatible with ‘transfer_light_from_lightmap’
string (uri)
Optional callback URL that will receive asynchronous notifications whenever the task changes status.Format: uri
Generated from the schema Router serves at GET /v2/models/freepik/ai-image-relight/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

object
required
string (uri)[]
required
The finished generation’s image URLs. Present and non-empty on the document Router returns; this list IS the result. The links are Freepik’s own and expire.
string
required
Possible values: COMPLETED
string (uuid)
Format: uuid

Examples

Input

Output

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes. When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider, and a 413 means the request body was larger than Router accepts. Download generated assets promptly because result URLs can expire. Any size limit named in a field description above is the provider’s own bound on that field, quoted from the provider’s specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see request body size. This page documents one partner model called through Comfy Router. The same comfy-sdk / @comfyorg/sdk package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: Comfy(api_key=...) / new Comfy({ apiKey }), with client.workflows, client.assets and client.jobs. See Comfy SDKs.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.