Chroma Key
curl --request POST \
--url https://api.example.com/api/v1/vfx/chroma-key \
--header 'Content-Type: application/json' \
--data '
{
"asset_id": "<string>",
"color": "#00ff00",
"similarity": 0.1,
"blend": 0.05,
"despill": "green",
"output": "transparent",
"export_format": "webm",
"bg_asset_id": "<string>",
"mode": "manual",
"light_wrap": 0
}
'import requests
url = "https://api.example.com/api/v1/vfx/chroma-key"
payload = {
"asset_id": "<string>",
"color": "#00ff00",
"similarity": 0.1,
"blend": 0.05,
"despill": "green",
"output": "transparent",
"export_format": "webm",
"bg_asset_id": "<string>",
"mode": "manual",
"light_wrap": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
asset_id: '<string>',
color: '#00ff00',
similarity: 0.1,
blend: 0.05,
despill: 'green',
output: 'transparent',
export_format: 'webm',
bg_asset_id: '<string>',
mode: 'manual',
light_wrap: 0
})
};
fetch('https://api.example.com/api/v1/vfx/chroma-key', 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.example.com/api/v1/vfx/chroma-key",
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([
'asset_id' => '<string>',
'color' => '#00ff00',
'similarity' => 0.1,
'blend' => 0.05,
'despill' => 'green',
'output' => 'transparent',
'export_format' => 'webm',
'bg_asset_id' => '<string>',
'mode' => 'manual',
'light_wrap' => 0
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/vfx/chroma-key"
payload := strings.NewReader("{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/vfx/chroma-key")
.header("Content-Type", "application/json")
.body("{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/vfx/chroma-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}vfx
Chroma Key
Green/blue-screen key + despill. Gated on vfx. transparent exports an alpha clip
(WebM/ProRes); replace composites over bg_asset_id.
POST
/
api
/
v1
/
vfx
/
chroma-key
Chroma Key
curl --request POST \
--url https://api.example.com/api/v1/vfx/chroma-key \
--header 'Content-Type: application/json' \
--data '
{
"asset_id": "<string>",
"color": "#00ff00",
"similarity": 0.1,
"blend": 0.05,
"despill": "green",
"output": "transparent",
"export_format": "webm",
"bg_asset_id": "<string>",
"mode": "manual",
"light_wrap": 0
}
'import requests
url = "https://api.example.com/api/v1/vfx/chroma-key"
payload = {
"asset_id": "<string>",
"color": "#00ff00",
"similarity": 0.1,
"blend": 0.05,
"despill": "green",
"output": "transparent",
"export_format": "webm",
"bg_asset_id": "<string>",
"mode": "manual",
"light_wrap": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
asset_id: '<string>',
color: '#00ff00',
similarity: 0.1,
blend: 0.05,
despill: 'green',
output: 'transparent',
export_format: 'webm',
bg_asset_id: '<string>',
mode: 'manual',
light_wrap: 0
})
};
fetch('https://api.example.com/api/v1/vfx/chroma-key', 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.example.com/api/v1/vfx/chroma-key",
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([
'asset_id' => '<string>',
'color' => '#00ff00',
'similarity' => 0.1,
'blend' => 0.05,
'despill' => 'green',
'output' => 'transparent',
'export_format' => 'webm',
'bg_asset_id' => '<string>',
'mode' => 'manual',
'light_wrap' => 0
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/vfx/chroma-key"
payload := strings.NewReader("{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/vfx/chroma-key")
.header("Content-Type", "application/json")
.body("{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/vfx/chroma-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"asset_id\": \"<string>\",\n \"color\": \"#00ff00\",\n \"similarity\": 0.1,\n \"blend\": 0.05,\n \"despill\": \"green\",\n \"output\": \"transparent\",\n \"export_format\": \"webm\",\n \"bg_asset_id\": \"<string>\",\n \"mode\": \"manual\",\n \"light_wrap\": 0\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Response
Successful Response
The response is of type Response Chroma Key Api V1 Vfx Chroma Key Post · object.
⌘I