Skip to main content
POST
image.edit

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
prompt
string
required

Describe the edit or composition.

Required string length: 1 - 4000
images
object[]
required

Source images, 1 to 10; sources may support fewer.

Required array length: 1 - 10 elements
tier
enum<string>
default:economy

Cost and quality tier. Default economy; premium is explicit.

Available options:
economy,
standard,
premium
rendering
enum<string>
default:general

Rendering approach: general, text detail, context preservation, natural photography, classic generation, or detailed diffusion. Unsupported combinations decline.

Available options:
general,
typography,
context,
natural,
classic,
detailed
latency
enum<string>

Speed preference within the economy tier. Default lowest.

Available options:
lowest,
balanced
preview
boolean

Opt into early model updates, where available.

count
integer
default:1

Number of independent images, 1 to 4. Default 1.

Required range: 1 <= x <= 4
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
negativePrompt
string

What to exclude. A source without this control declines.

Required string length: 1 - 4000
width
integer

Exact output width. Send with height, instead of aspectRatio.

Required range: 64 <= x <= 4096
height
integer

Exact output height. Send with width, instead of aspectRatio.

Required range: 64 <= x <= 4096
aspectRatio
string

Width:height ratio, such as 16:9, instead of exact dimensions.

Required string length: 1 - 16
Pattern: ^\d{1,4}:\d{1,4}$
resolution
enum<string>

Equal-area resolution class; exact dimensions depend on aspect ratio. 4096 is an explicit expensive option.

Available options:
768,
1024,
1536,
2048,
4096
moderationTolerance
integer

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

Required range: 0 <= x <= 6
enhancePrompt
boolean

Allow the source to expand the prompt where supported.

guidance
number

Prompt adherence strength where supported.

Required range: 1.5 <= x <= 100
steps
integer

Rendering steps where supported.

Required range: 1 <= x <= 50
grounding
boolean

Allow external research to inform the image where supported.

layout
object[]

Placement guidance. Boxes guide composition; they do not guarantee exact clipping.

Required array length: 1 - 50 elements

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.