Skip to main content
POST
/
api
/
v1
/
templates
/
recommend
Get recommendations
curl --request POST \
  --url https://api.kynva.ai/api/v1/templates/recommend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brief": {
    "output": {},
    "visual": {},
    "brand": {},
    "content": {}
  },
  "count": 5,
  "excludeIds": [
    "<string>"
  ],
  "diversify": true
}
'
import requests

url = "https://api.kynva.ai/api/v1/templates/recommend"

payload = {
"brief": {
"output": {},
"visual": {},
"brand": {},
"content": {}
},
"count": 5,
"excludeIds": ["<string>"],
"diversify": True
}
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: {output: {}, visual: {}, brand: {}, content: {}},
count: 5,
excludeIds: ['<string>'],
diversify: true
})
};

fetch('https://api.kynva.ai/api/v1/templates/recommend', 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/templates/recommend",
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' => [
'output' => [

],
'visual' => [

],
'brand' => [

],
'content' => [

]
],
'count' => 5,
'excludeIds' => [
'<string>'
],
'diversify' => true
]),
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/templates/recommend"

payload := strings.NewReader("{\n \"brief\": {\n \"output\": {},\n \"visual\": {},\n \"brand\": {},\n \"content\": {}\n },\n \"count\": 5,\n \"excludeIds\": [\n \"<string>\"\n ],\n \"diversify\": true\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/templates/recommend")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": {\n \"output\": {},\n \"visual\": {},\n \"brand\": {},\n \"content\": {}\n },\n \"count\": 5,\n \"excludeIds\": [\n \"<string>\"\n ],\n \"diversify\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kynva.ai/api/v1/templates/recommend")

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 \"output\": {},\n \"visual\": {},\n \"brand\": {},\n \"content\": {}\n },\n \"count\": 5,\n \"excludeIds\": [\n \"<string>\"\n ],\n \"diversify\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "recommendations": "<array>"
  }
}

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

Partial StyleBrief for matching

count
number
default:5
Required range: x <= 20
excludeIds
string[]
diversify
boolean
default:true

Response

200 - application/json

Template recommendations with scores

Template recommendations with scores

success
boolean
data
object