Skip to main content
POST
image.style.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
output
enum<string>
default:raster

Raster pixels or scalable vector artwork.

Available options:
raster,
vector
profile
enum<string>
default:style-match

General images, precise prompts, reference style matching, classic or legacy rendering.

Available options:
general,
utility,
style-match,
classic,
legacy
quality
enum<string>
default:standard

Standard or explicitly selected higher resolution.

Available options:
standard,
pro
revision
enum<string>
default:current

Current or previous general rendering revision.

Available options:
current,
previous
referenceImages
object[]

One to ten reference images; at most 64 MB total. Supplied images may depict people.

Required array length: 1 - 10 elements
ref
string

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})$
imageWeights
number[]

Nonnegative weights, one for each reference image.

Maximum array length: 10
Required range: x >= 0
sourceStyleWeight
number

Nonnegative weight for the single source style ref.

Required range: x >= 0
styleMatch
enum<string>

How closely future images should match this style; regular for classic or legacy profiles.

Available options:
regular,
flexible,
precise
prompt
string

Optional description stored with the style. Classic and legacy profiles allow at most 1000 characters.

Required string length: 1 - 10000
palette
object

Preferred colors stored with this style.

baseStyle
enum<string>

Optional base rendering style; availability depends on profile and output.

Available options:
any,
photo,
illustration,
vector,
icon
mixPolicy
enum<string>

How reference images and a source style are mixed; classic and legacy profiles only.

Available options:
palette-match,
max-weight

Response

The result

output
enum<string>
required
Available options:
raster,
vector
profile
enum<string>
required
Available options:
general,
utility,
style-match,
classic,
legacy
quality
enum<string>
required
Available options:
standard,
pro
revision
enum<string>
required
Available options:
current,
previous
createdAt
string<date-time>
required

UTC date when this saved style was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
private
boolean
required

Saved styles are private to the caller.

ref
string

Reference to what this call created. Pass it as ref to image.style.get, image.style.render or image.style.delete.