Skip to main content
POST
image.relight

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fileId
string

Id of an uploaded file holding the subject image, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
imageUrl
string

Public link to the subject image, instead of fileId.

backgroundPrompt
string

New background or lighting description, up to 10000 characters.

Required string length: 1 - 10000
backgroundFileId
string

Id of an uploaded file holding a reference background image, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
backgroundUrl
string

Public link to a background reference, instead of backgroundFileId.

foregroundPrompt
string

Description of the subject to preserve.

Required string length: 1 - 10000
negativePrompt
string

What to exclude from the output.

Required string length: 1 - 10000
preserveSubject
number
default:0.6

How closely to preserve the subject pixels, 0 to 1. Default 0.6.

Required range: 0 <= x <= 1
backgroundDepth
number
default:0.5

How closely to preserve the original background depth, 0 to 1. Default 0.5.

Required range: 0 <= x <= 1
keepBackground
boolean
default:false

Keep the original background and change its lighting. Default false.

lightFileId
string

Id of an uploaded file holding a lighting reference image, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
lightUrl
string

Public link to a light reference, instead of lightFileId.

lightDirection
enum<string>

Direction of the light source.

Available options:
left,
right,
above,
below
lightStrength
number

Light strength, 0 to 1; requires a light reference or direction.

Required range: 0 <= x <= 1
seed
integer

Random seed; omit or use 0 for a random seed.

Required range: 0 <= x <= 4294967294
format
enum<string>
default:png

Output image format. Default png.

Available options:
png,
jpeg,
webp

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.