Skip to main content
POST
/
api
/
v1
/
ai
/
insert-object
Insert object into scene
curl --request POST \
  --url https://api.kynva.ai/api/v1/ai/insert-object \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backgroundUrl": "<string>",
  "objectUrl": "<string>",
  "placement": "auto",
  "customPosition": {
    "x": 123,
    "y": 123
  },
  "scale": 1,
  "blendMode": "normal",
  "shadowEnabled": false,
  "shadow": {
    "offsetX": 5,
    "offsetY": 5,
    "blur": 10,
    "opacity": 0.5,
    "color": "#000000"
  },
  "prompt": "<string>",
  "outputFormat": "png",
  "quality": 90
}
'
import requests

url = "https://api.kynva.ai/api/v1/ai/insert-object"

payload = {
"backgroundUrl": "<string>",
"objectUrl": "<string>",
"placement": "auto",
"customPosition": {
"x": 123,
"y": 123
},
"scale": 1,
"blendMode": "normal",
"shadowEnabled": False,
"shadow": {
"offsetX": 5,
"offsetY": 5,
"blur": 10,
"opacity": 0.5,
"color": "#000000"
},
"prompt": "<string>",
"outputFormat": "png",
"quality": 90
}
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({
backgroundUrl: '<string>',
objectUrl: '<string>',
placement: 'auto',
customPosition: {x: 123, y: 123},
scale: 1,
blendMode: 'normal',
shadowEnabled: false,
shadow: {offsetX: 5, offsetY: 5, blur: 10, opacity: 0.5, color: '#000000'},
prompt: '<string>',
outputFormat: 'png',
quality: 90
})
};

fetch('https://api.kynva.ai/api/v1/ai/insert-object', 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/ai/insert-object",
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([
'backgroundUrl' => '<string>',
'objectUrl' => '<string>',
'placement' => 'auto',
'customPosition' => [
'x' => 123,
'y' => 123
],
'scale' => 1,
'blendMode' => 'normal',
'shadowEnabled' => false,
'shadow' => [
'offsetX' => 5,
'offsetY' => 5,
'blur' => 10,
'opacity' => 0.5,
'color' => '#000000'
],
'prompt' => '<string>',
'outputFormat' => 'png',
'quality' => 90
]),
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/ai/insert-object"

payload := strings.NewReader("{\n \"backgroundUrl\": \"<string>\",\n \"objectUrl\": \"<string>\",\n \"placement\": \"auto\",\n \"customPosition\": {\n \"x\": 123,\n \"y\": 123\n },\n \"scale\": 1,\n \"blendMode\": \"normal\",\n \"shadowEnabled\": false,\n \"shadow\": {\n \"offsetX\": 5,\n \"offsetY\": 5,\n \"blur\": 10,\n \"opacity\": 0.5,\n \"color\": \"#000000\"\n },\n \"prompt\": \"<string>\",\n \"outputFormat\": \"png\",\n \"quality\": 90\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/ai/insert-object")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"backgroundUrl\": \"<string>\",\n \"objectUrl\": \"<string>\",\n \"placement\": \"auto\",\n \"customPosition\": {\n \"x\": 123,\n \"y\": 123\n },\n \"scale\": 1,\n \"blendMode\": \"normal\",\n \"shadowEnabled\": false,\n \"shadow\": {\n \"offsetX\": 5,\n \"offsetY\": 5,\n \"blur\": 10,\n \"opacity\": 0.5,\n \"color\": \"#000000\"\n },\n \"prompt\": \"<string>\",\n \"outputFormat\": \"png\",\n \"quality\": 90\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kynva.ai/api/v1/ai/insert-object")

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 \"backgroundUrl\": \"<string>\",\n \"objectUrl\": \"<string>\",\n \"placement\": \"auto\",\n \"customPosition\": {\n \"x\": 123,\n \"y\": 123\n },\n \"scale\": 1,\n \"blendMode\": \"normal\",\n \"shadowEnabled\": false,\n \"shadow\": {\n \"offsetX\": 5,\n \"offsetY\": 5,\n \"blur\": 10,\n \"opacity\": 0.5,\n \"color\": \"#000000\"\n },\n \"prompt\": \"<string>\",\n \"outputFormat\": \"png\",\n \"quality\": 90\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "url": "<string>",
    "width": 123,
    "height": 123,
    "placement": {
      "x": 123,
      "y": 123,
      "scale": 123
    },
    "confidence": 123,
    "reasoning": "<string>",
    "processingTime": 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
backgroundUrl
string<uri>
required

URL of the background/scene image

objectUrl
string<uri>
required

URL of the object image (should have transparent background)

placement
enum<string>
default:auto

Placement strategy (auto uses Claude Vision for intelligent placement)

Available options:
auto,
center,
left,
right,
top,
bottom,
custom
customPosition
object

Custom position (only used when placement is "custom")

scale
number
default:1
Required range: 0.1 <= x <= 3
blendMode
enum<string>
default:normal
Available options:
normal,
multiply,
screen,
overlay,
soft-light,
hard-light
shadowEnabled
boolean
default:false
shadow
object
prompt
string

Hint for AI placement: "place on the table"

outputFormat
enum<string>
default:png
Available options:
png,
webp,
jpg
quality
number
default:90
Required range: 1 <= x <= 100

Response

200 - application/json

Object inserted successfully

Object inserted successfully

success
boolean
data
object