Skip to main content
POST
Create image (sync)

Authorizations

Authorization
string
header
required

Your Kynva API key (kyn_live_xxx or kyn_test_xxx; legacy rf_ keys remain valid)

Query Parameters

strict
boolean
default:false

Fail on invalid modification properties instead of using fallbacks

cache
boolean
default:true

Use render cache (set to false to force re-render)

Body

application/json
templateId
string
required

ID of the template to render

modifications
object[]

Array of layer modifications (see docs/MODIFICATIONS.md for full list)

format
enum<string>
default:webp

Output format

Available options:
png,
jpg,
webp
scale
number
default:2

Resolution multiplier

Required range: 1 <= x <= 3
metadata
object

Custom metadata

brandId
string

Brand ID for consistency validation (optional)

stylePreset
string

Style preset ID to apply (e.g., "retro-80s", "cinematic-teal-orange")

variables
object

Variables for conditional logic and text interpolation (e.g., { "price": 150, "status": "active" })

Response

200 - application/json

Image generated successfully

Image generated successfully

success
boolean
data
object