Create image (sync)
curl --request POST \
--url https://api.kynva.ai/api/v1/images/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": "<string>",
"modifications": [
{
"name": "<string>",
"text": "<string>",
"src": "<string>",
"color": "<string>",
"hide": true,
"textEffect": "<string>",
"gradientFill": {},
"gradient": {},
"texture": "<string>"
}
],
"format": "webp",
"scale": 2,
"metadata": {},
"brandId": "<string>",
"stylePreset": "<string>",
"variables": {}
}
'import requests
url = "https://api.kynva.ai/api/v1/images/sync"
payload = {
"templateId": "<string>",
"modifications": [
{
"name": "<string>",
"text": "<string>",
"src": "<string>",
"color": "<string>",
"hide": True,
"textEffect": "<string>",
"gradientFill": {},
"gradient": {},
"texture": "<string>"
}
],
"format": "webp",
"scale": 2,
"metadata": {},
"brandId": "<string>",
"stylePreset": "<string>",
"variables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: '<string>',
modifications: [
{
name: '<string>',
text: '<string>',
src: '<string>',
color: '<string>',
hide: true,
textEffect: '<string>',
gradientFill: {},
gradient: {},
texture: '<string>'
}
],
format: 'webp',
scale: 2,
metadata: {},
brandId: '<string>',
stylePreset: '<string>',
variables: {}
})
};
fetch('https://api.kynva.ai/api/v1/images/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kynva.ai/api/v1/images/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateId' => '<string>',
'modifications' => [
[
'name' => '<string>',
'text' => '<string>',
'src' => '<string>',
'color' => '<string>',
'hide' => true,
'textEffect' => '<string>',
'gradientFill' => [
],
'gradient' => [
],
'texture' => '<string>'
]
],
'format' => 'webp',
'scale' => 2,
'metadata' => [
],
'brandId' => '<string>',
'stylePreset' => '<string>',
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kynva.ai/api/v1/images/sync"
payload := strings.NewReader("{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kynva.ai/api/v1/images/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kynva.ai/api/v1/images/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"status": "completed",
"imageUrl": "<string>",
"width": 123,
"height": 123,
"format": "<string>",
"renderTime": 123,
"cached": true,
"stylePreset": "<string>",
"warnings": [
{
"property": "<string>",
"value": "<unknown>",
"message": "<string>",
"fallback": "<unknown>"
}
],
"brandValidation": {
"valid": true,
"brandName": "<string>",
"violations": "<array>",
"summary": {}
}
}
}Images
Create image (sync)
Generate an image synchronously. Waits for render to complete and returns the image URL. Use ?strict=true to fail on invalid modifications.
POST
/
api
/
v1
/
images
/
sync
Create image (sync)
curl --request POST \
--url https://api.kynva.ai/api/v1/images/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": "<string>",
"modifications": [
{
"name": "<string>",
"text": "<string>",
"src": "<string>",
"color": "<string>",
"hide": true,
"textEffect": "<string>",
"gradientFill": {},
"gradient": {},
"texture": "<string>"
}
],
"format": "webp",
"scale": 2,
"metadata": {},
"brandId": "<string>",
"stylePreset": "<string>",
"variables": {}
}
'import requests
url = "https://api.kynva.ai/api/v1/images/sync"
payload = {
"templateId": "<string>",
"modifications": [
{
"name": "<string>",
"text": "<string>",
"src": "<string>",
"color": "<string>",
"hide": True,
"textEffect": "<string>",
"gradientFill": {},
"gradient": {},
"texture": "<string>"
}
],
"format": "webp",
"scale": 2,
"metadata": {},
"brandId": "<string>",
"stylePreset": "<string>",
"variables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: '<string>',
modifications: [
{
name: '<string>',
text: '<string>',
src: '<string>',
color: '<string>',
hide: true,
textEffect: '<string>',
gradientFill: {},
gradient: {},
texture: '<string>'
}
],
format: 'webp',
scale: 2,
metadata: {},
brandId: '<string>',
stylePreset: '<string>',
variables: {}
})
};
fetch('https://api.kynva.ai/api/v1/images/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kynva.ai/api/v1/images/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateId' => '<string>',
'modifications' => [
[
'name' => '<string>',
'text' => '<string>',
'src' => '<string>',
'color' => '<string>',
'hide' => true,
'textEffect' => '<string>',
'gradientFill' => [
],
'gradient' => [
],
'texture' => '<string>'
]
],
'format' => 'webp',
'scale' => 2,
'metadata' => [
],
'brandId' => '<string>',
'stylePreset' => '<string>',
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kynva.ai/api/v1/images/sync"
payload := strings.NewReader("{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kynva.ai/api/v1/images/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kynva.ai/api/v1/images/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": \"<string>\",\n \"modifications\": [\n {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"src\": \"<string>\",\n \"color\": \"<string>\",\n \"hide\": true,\n \"textEffect\": \"<string>\",\n \"gradientFill\": {},\n \"gradient\": {},\n \"texture\": \"<string>\"\n }\n ],\n \"format\": \"webp\",\n \"scale\": 2,\n \"metadata\": {},\n \"brandId\": \"<string>\",\n \"stylePreset\": \"<string>\",\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"status": "completed",
"imageUrl": "<string>",
"width": 123,
"height": 123,
"format": "<string>",
"renderTime": 123,
"cached": true,
"stylePreset": "<string>",
"warnings": [
{
"property": "<string>",
"value": "<unknown>",
"message": "<string>",
"fallback": "<unknown>"
}
],
"brandValidation": {
"valid": true,
"brandName": "<string>",
"violations": "<array>",
"summary": {}
}
}
}Authorizations
Your Kynva API key (kyn_live_xxx or kyn_test_xxx; legacy rf_ keys remain valid)
Query Parameters
Fail on invalid modification properties instead of using fallbacks
Use render cache (set to false to force re-render)
Body
application/json
ID of the template to render
Array of layer modifications (see docs/MODIFICATIONS.md for full list)
Show child attributes
Show child attributes
Output format
Available options:
png, jpg, webp Resolution multiplier
Required range:
1 <= x <= 3Custom metadata
Brand ID for consistency validation (optional)
Style preset ID to apply (e.g., "retro-80s", "cinematic-teal-orange")
Variables for conditional logic and text interpolation (e.g., { "price": 150, "status": "active" })
⌘I