Skip to main content
POST
image.style.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
ref
string
required

The ref returned by image.style.create or a row of image.styles.list or image.style-presets.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
prompt
string
required

What the image should show. Classic and legacy styles accept at most 1000 characters.

Required string length: 1 - 10000
count
integer
default:1

Number of alternatives of the same prompt, 1 to 6; default one.

Required range: 1 <= x <= 6
aspectRatio
enum<string>

Image aspect ratio; omit to infer it from the prompt.

Available options:
1:1,
2:1,
1:2,
3:2,
2:3,
4:3,
3:4,
5:4,
4:5,
6:10,
14:10,
10:14,
16:9,
9:16
exactSize
string

Exact raster size from the rendering profile's supported sizes; cannot combine with aspectRatio.

Pattern: ^\d{3,4}x\d{3,4}$
seed
integer

Optional reproducible random seed.

Required range: 0 <= x <= 4294967295
negativePrompt
string

What to avoid; classic and legacy styles only.

Required string length: 1 - 1000
styleMatch
enum<string>

Override how closely this image matches its saved style.

Available options:
regular,
flexible,
precise
palette
object

Preferred colors for this generation.

artisticLevel
integer

Artistic tone, 0 to 5; classic styles only.

Required range: 0 <= x <= 5
excludeText
boolean

Avoid embedding text; classic styles only.

textLayout
object[]

Positioned words; classic styles only.

Maximum array length: 100
format
enum<string>
default:webp

Raster file format; vector styles always produce SVG.

Available options:
png,
webp
retention
enum<string>
default:standard

Transient prompt and image retention; saved styles remain saved.

Available options:
none,
standard
upscale
enum<string>
default:none

Optional resolution add-on. Its price estimate is provisional.

Available options:
none,
4mp,
16mp

Response

The result

images
object[]
required

Generated files in the caller's storage, kept for seven days.

Minimum array length: 1