Skip to main content
POST
/
api
/
v1
/
render
/
multi-platform
Multi-platform render
curl --request POST \
  --url https://api.kynva.ai/api/v1/render/multi-platform \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brief": {
    "brand": {},
    "content": {},
    "visual": {},
    "output": {},
    "briefId": "<string>",
    "options": {},
    "metadata": {}
  },
  "platforms": [
    {}
  ],
  "adaptationMode": "reflow",
  "respectSafeZones": true,
  "letterboxColor": "#000000"
}
'
import requests

url = "https://api.kynva.ai/api/v1/render/multi-platform"

payload = {
"brief": {
"brand": {},
"content": {},
"visual": {},
"output": {},
"briefId": "<string>",
"options": {},
"metadata": {}
},
"platforms": [{}],
"adaptationMode": "reflow",
"respectSafeZones": True,
"letterboxColor": "#000000"
}
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({
brief: {
brand: {},
content: {},
visual: {},
output: {},
briefId: '<string>',
options: {},
metadata: {}
},
platforms: [{}],
adaptationMode: 'reflow',
respectSafeZones: true,
letterboxColor: '#000000'
})
};

fetch('https://api.kynva.ai/api/v1/render/multi-platform', 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/render/multi-platform",
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([
'brief' => [
'brand' => [

],
'content' => [

],
'visual' => [

],
'output' => [

],
'briefId' => '<string>',
'options' => [

],
'metadata' => [

]
],
'platforms' => [
[

]
],
'adaptationMode' => 'reflow',
'respectSafeZones' => true,
'letterboxColor' => '#000000'
]),
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/render/multi-platform"

payload := strings.NewReader("{\n \"brief\": {\n \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"metadata\": {}\n },\n \"platforms\": [\n {}\n ],\n \"adaptationMode\": \"reflow\",\n \"respectSafeZones\": true,\n \"letterboxColor\": \"#000000\"\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/render/multi-platform")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": {\n \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"metadata\": {}\n },\n \"platforms\": [\n {}\n ],\n \"adaptationMode\": \"reflow\",\n \"respectSafeZones\": true,\n \"letterboxColor\": \"#000000\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kynva.ai/api/v1/render/multi-platform")

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 \"brief\": {\n \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"metadata\": {}\n },\n \"platforms\": [\n {}\n ],\n \"adaptationMode\": \"reflow\",\n \"respectSafeZones\": true,\n \"letterboxColor\": \"#000000\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "requestId": "<string>",
  "briefId": "<string>",
  "status": "<string>",
  "renders": [
    {
      "platform": "<string>",
      "format": "<string>",
      "formatName": "<string>",
      "id": "<string>",
      "url": "<string>",
      "width": 123,
      "height": 123,
      "aspectRatio": "<string>",
      "imageFormat": "<string>",
      "size": 123,
      "renderTime": 123,
      "warnings": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "processingTime": 123,
    "sourceTemplate": "<string>",
    "adaptationMode": "<string>",
    "platformsRendered": 123,
    "platformsFailed": 123
  },
  "usage": {
    "renderCredits": 123,
    "aiImageCredits": 123,
    "totalCredits": 123
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
brief
object
required

Style Brief defining the content to render

platforms
object[]
required

Target platform/format combinations

Required array length: 1 - 20 elements
adaptationMode
enum<string>
default:reflow

How to adapt content to different dimensions

Available options:
scale,
reflow,
crop,
letterbox,
smart
respectSafeZones
boolean
default:true

Keep content within platform safe zones

letterboxColor
string
default:#000000

Background color for letterbox mode

Response

200 - application/json

Multi-platform render completed

Multi-platform render completed

success
boolean
requestId
string
briefId
string
status
string
renders
object[]
meta
object
usage
object