Skip to main content
POST
image.garment.render

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
view
enum<string>
required

Camera view for the output.

Available options:
front,
three-quarter,
back
sourceImages
object[]

Additional garment photos; total across all fields at most 10.

Maximum array length: 10
front
object

Optional front view.

back
object

Optional back view.

left
object

Optional left view.

right
object

Optional right view.

top
object

Optional top view.

bottom
object

Optional bottom view.

instructions
string

Image instructions, up to 4000 characters.

Required string length: 1 - 4000
metadata
object

Factual garment context.

aspectRatio
enum<string>

Output shape; absent keeps the source shape.

Available options:
1:1,
3:4,
4:3,
16:9,
9:16
quality
enum<string>
default:low

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

Available options:
low,
medium,
high
seed
integer

A seed for repeatable rendering where supported.

Required range: 0 <= x <= 2147483647

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.