Skip to main content
POST
image.background.replace

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
source
object
required

An image you uploaded; at most 20 MB.

background
object
required

Exactly one background: a description, color, or uploaded image.

count
integer
default:1

Number of outputs, 1 to 4. Default 1.

Required range: 1 <= x <= 4
quality
enum<string>
default:low

Detail level. High is an explicit, dearer choice. Default low.

Available options:
low,
medium,
high
speed
enum<string>

Rendering speed where supported.

Available options:
fast,
balanced,
best
seed
integer

A seed for repeatable rendering where supported.

Required range: 0 <= x <= 2147483647
stylePreset
string

Optional style preset; a source may decline it.

Maximum string length: 100
palette
string[]

Suggested background colors; a source may decline.

Required array length: 1 - 20 elements

Six-digit suggested color.

Pattern: ^#[0-9a-fA-F]{6}$
styleCodes
string[]

Optional eight-digit style codes.

Maximum array length: 10
Pattern: ^[0-9a-fA-F]{8}$
styleReferences
object[]

Optional style images.

Maximum array length: 5
rewritePrompt
boolean

Whether to expand the background description.

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.