Skip to main content
POST
/
api
/
v1
/
render
/
brief
Render from brief
curl --request POST \
  --url https://api.kynva.ai/api/v1/render/brief \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": {},
  "content": {},
  "visual": {},
  "output": {},
  "briefId": "<string>",
  "options": {},
  "webhookUrl": "<string>",
  "metadata": {}
}
'
import requests

url = "https://api.kynva.ai/api/v1/render/brief"

payload = {
"brand": {},
"content": {},
"visual": {},
"output": {},
"briefId": "<string>",
"options": {},
"webhookUrl": "<string>",
"metadata": {}
}
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({
brand: {},
content: {},
visual: {},
output: {},
briefId: '<string>',
options: {},
webhookUrl: '<string>',
metadata: {}
})
};

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

],
'content' => [

],
'visual' => [

],
'output' => [

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

],
'webhookUrl' => '<string>',
'metadata' => [

]
]),
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/brief"

payload := strings.NewReader("{\n \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"webhookUrl\": \"<string>\",\n \"metadata\": {}\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/brief")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"webhookUrl\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kynva.ai/api/v1/render/brief")

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 \"brand\": {},\n \"content\": {},\n \"visual\": {},\n \"output\": {},\n \"briefId\": \"<string>\",\n \"options\": {},\n \"webhookUrl\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "requestId": "<string>",
  "briefId": "<string>",
  "status": "<string>",
  "renders": [
    {}
  ],
  "meta": {
    "processingTime": 123,
    "templatesUsed": "<array>",
    "imagesGenerated": 123,
    "cached": true
  },
  "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
brand
object
required
content
object
required
visual
object
required
output
object
required
briefId
string
options
object
webhookUrl
string
metadata
object

Response

200 - application/json

Render completed

Render completed

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