Skip to main content
POST
image.upscale

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.

scale

Multiply source width and height by 2, 4 or 8.

targetSize
object

Exact dimensions or a nearest size tier, instead of scale.

enhancement
enum<string>
default:automatic

Enhancement behavior; a source may decline unsupported combinations.

Available options:
automatic,
faithful,
text,
creative,
detailed,
reconstruct
prompt
string

Image instructions, up to 4000 characters.

Required string length: 1 - 4000
seed
integer

A seed for repeatable rendering where supported.

Required range: 0 <= x <= 2147483647
creativity
integer

Reinterpretation strength, 1 to 9.

Required range: 1 <= x <= 9
colorPreservation
boolean

Keep source colors.

automaticDescription
boolean

Describe the image automatically; incompatible with prompt when true.

texture
integer

Added texture, 1 to 5.

Required range: 1 <= x <= 5
detail
boolean

Apply a detail adjustment.

detailStrength
number

Detail intensity, 0 to 10; requires detail=true.

Required range: 0 <= x <= 10
strength
number

Enhancement intensity, 0.01 to 1.

Required range: 0.01 <= x <= 1
sharpen
number

Edge sharpening, 0 to 1.

Required range: 0 <= x <= 1
denoise
number

Noise removal, 0 to 1.

Required range: 0 <= x <= 1
compressionRepair
number

Compression artifact removal, 0 to 1.

Required range: 0 <= x <= 1
faceEnhancement
boolean

Recover face detail; true requires strength and creativity.

faceEnhancementStrength
number

Face recovery strength, 0 to 1.

Required range: 0 <= x <= 1
faceEnhancementCreativity
number

Face reinterpretation, 0 to 1.

Required range: 0 <= x <= 1
subjectDetection
enum<string>

Where to apply enhancement.

Available options:
all,
foreground,
background
enhancementStrength
enum<string>

Reconstruction strength.

Available options:
low,
medium,
high

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.