Skip to main content
POST
image.try-on

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

Photo of the person to dress.

garment
object
required

Garment image; one slot can contain an outfit.

prompt
string
required

Describe the outfit and desired result.

Required string length: 1 - 4000
version
enum<string>
default:current

Current or previous rendering version. Default current.

Available options:
current,
legacy
seed
integer

Seed for reproducibility where supported.

Required range: 0 <= x <= 4294967295
format
enum<string>

Requested image file format where supported.

Available options:
jpeg,
png,
webp
moderationTolerance
integer

Moderation tolerance, lower is stricter. Sources decline unsupported levels.

Required range: 0 <= x <= 6

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.