Run: Remove Background (synchronous)
curl --request POST \
--url https://api.askeditor.com/v1/run/remove-background \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"material": "<string>"
}
'import requests
url = "https://api.askeditor.com/v1/run/remove-background"
payload = { "material": "<string>" }
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({material: '<string>'})
};
fetch('https://api.askeditor.com/v1/run/remove-background', 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.askeditor.com/v1/run/remove-background",
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([
'material' => '<string>'
]),
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.askeditor.com/v1/run/remove-background"
payload := strings.NewReader("{\n \"material\": \"<string>\"\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.askeditor.com/v1/run/remove-background")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"material\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.askeditor.com/v1/run/remove-background")
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 \"material\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "completed",
"processedVideoUrl": "<string>",
"canvasId": "<string>",
"editorPath": "<string>",
"credits": 123,
"creditsCharged": true,
"cached": true
}
}API Reference
Run: Remove Background (synchronous)
Cut the subject out of a video: the person isolated on a true alpha channel, ready to composite anywhere. SYNCHRONOUS: the call returns the finished cutout (~40-90s), no polling. The reflex call when an agent needs a background gone.
POST
/
v1
/
run
/
remove-background
Run: Remove Background (synchronous)
curl --request POST \
--url https://api.askeditor.com/v1/run/remove-background \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"material": "<string>"
}
'import requests
url = "https://api.askeditor.com/v1/run/remove-background"
payload = { "material": "<string>" }
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({material: '<string>'})
};
fetch('https://api.askeditor.com/v1/run/remove-background', 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.askeditor.com/v1/run/remove-background",
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([
'material' => '<string>'
]),
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.askeditor.com/v1/run/remove-background"
payload := strings.NewReader("{\n \"material\": \"<string>\"\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.askeditor.com/v1/run/remove-background")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"material\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.askeditor.com/v1/run/remove-background")
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 \"material\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "completed",
"processedVideoUrl": "<string>",
"canvasId": "<string>",
"editorPath": "<string>",
"credits": 123,
"creditsCharged": true,
"cached": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A public https url, or an upload-ticket material handle.
'best' (default) is the quality pick. 'fast' trades a little edge fidelity for speed.
Available options:
best, fast 'webm' (default) = VP9 with true alpha. 'mov' = ProRes 4444 alpha. 'mp4' = green screen.
Available options:
webm, mov, mp4