Skip to main content
POST
/
api
/
v1
/
pdf
/
sync
Create PDF (sync)
curl --request POST \
  --url https://api.kynva.ai/api/v1/pdf/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "<string>",
  "modifications": [
    {
      "name": "<string>",
      "text": "<string>",
      "src": "<string>",
      "color": "<string>",
      "hide": true
    }
  ],
  "landscape": false,
  "printBackground": true,
  "metadata": {}
}
'
import requests

url = "https://api.kynva.ai/api/v1/pdf/sync"

payload = {
"templateId": "<string>",
"modifications": [
{
"name": "<string>",
"text": "<string>",
"src": "<string>",
"color": "<string>",
"hide": True
}
],
"landscape": False,
"printBackground": True,
"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({
templateId: '<string>',
modifications: [
{
name: '<string>',
text: '<string>',
src: '<string>',
color: '<string>',
hide: true
}
],
landscape: false,
printBackground: true,
metadata: {}
})
};

fetch('https://api.kynva.ai/api/v1/pdf/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/pdf/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
]
],
'landscape' => false,
'printBackground' => true,
'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/pdf/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 }\n ],\n \"landscape\": false,\n \"printBackground\": true,\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/pdf/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 }\n ],\n \"landscape\": false,\n \"printBackground\": true,\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kynva.ai/api/v1/pdf/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 }\n ],\n \"landscape\": false,\n \"printBackground\": true,\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "id": "<string>",
    "status": "completed",
    "pdfUrl": "<string>",
    "format": "pdf",
    "renderTime": 123,
    "warnings": [
      {
        "property": "<string>",
        "value": "<unknown>",
        "message": "<string>",
        "fallback": "<unknown>"
      }
    ]
  }
}

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

Body

application/json
templateId
string
required

ID of the template to render

modifications
object[]

Array of layer modifications

landscape
boolean
default:false

Landscape orientation

printBackground
boolean
default:true

Print background colors/images

metadata
object

Custom metadata

Response

200 - application/json

PDF generated successfully

PDF generated successfully

success
boolean
data
object