curl --request POST \
--url https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"regions": [
{
"start_ms": 1,
"end_ms": 1,
"bbox": {
"x": 0.5,
"y": 0.5,
"w": 0,
"h": 0
},
"effect": "blur",
"source": "manual",
"label": "<string>"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions"
payload = { "regions": [
{
"start_ms": 1,
"end_ms": 1,
"bbox": {
"x": 0.5,
"y": 0.5,
"w": 0,
"h": 0
},
"effect": "blur",
"source": "manual",
"label": "<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({
regions: [
{
start_ms: 1,
end_ms: 1,
bbox: {x: 0.5, y: 0.5, w: 0, h: 0},
effect: 'blur',
source: 'manual',
label: '<string>'
}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions', 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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions",
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([
'regions' => [
[
'start_ms' => 1,
'end_ms' => 1,
'bbox' => [
'x' => 0.5,
'y' => 0.5,
'w' => 0,
'h' => 0
],
'effect' => 'blur',
'source' => 'manual',
'label' => '<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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions"
payload := strings.NewReader("{\n \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions")
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 \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"recording_id": "<string>",
"regions": [
{
"id": "<string>",
"start_ms": 123,
"end_ms": 123,
"duration_ms": 123,
"bbox": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"label": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Add recording visual-redaction regions
Add one or more spatiotemporal visual-redaction regions to a completed video-room recording so a player overlay or an export pipeline can blur/pixelate a face or on-camera PII (a badge, a document, a whiteboard). Each region is a normalised bounding box ({ x, y, w, h } as fractions of the frame, so it is resolution-independent) that applies over a [start_ms, end_ms] window with a visual effect and a provenance source. Submit a single box or a whole face-detection track (up to 200 regions per request). Boxes and windows are clamped to the frame and the recording’s duration; each window must be at least 100ms. Up to 500 regions per recording. Requires the voice:write scope and is audit-logged.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"regions": [
{
"start_ms": 1,
"end_ms": 1,
"bbox": {
"x": 0.5,
"y": 0.5,
"w": 0,
"h": 0
},
"effect": "blur",
"source": "manual",
"label": "<string>"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions"
payload = { "regions": [
{
"start_ms": 1,
"end_ms": 1,
"bbox": {
"x": 0.5,
"y": 0.5,
"w": 0,
"h": 0
},
"effect": "blur",
"source": "manual",
"label": "<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({
regions: [
{
start_ms: 1,
end_ms: 1,
bbox: {x: 0.5, y: 0.5, w: 0, h: 0},
effect: 'blur',
source: 'manual',
label: '<string>'
}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions', 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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions",
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([
'regions' => [
[
'start_ms' => 1,
'end_ms' => 1,
'bbox' => [
'x' => 0.5,
'y' => 0.5,
'w' => 0,
'h' => 0
],
'effect' => 'blur',
'source' => 'manual',
'label' => '<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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions"
payload := strings.NewReader("{\n \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\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.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/recordings/{id}/visual-redactions")
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 \"regions\": [\n {\n \"start_ms\": 1,\n \"end_ms\": 1,\n \"bbox\": {\n \"x\": 0.5,\n \"y\": 0.5,\n \"w\": 0,\n \"h\": 0\n },\n \"effect\": \"blur\",\n \"source\": \"manual\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"recording_id": "<string>",
"regions": [
{
"id": "<string>",
"start_ms": 123,
"end_ms": 123,
"duration_ms": 123,
"bbox": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"label": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Dashboard JWT token from Clerk
Path Parameters
Recording id to add the redaction region(s) to. Must be a completed video_room recording with stored media.
1 - 128Body
One or more redaction regions to add. All-or-nothing — the whole request is rejected if any region is invalid.
1 - 200 elementsShow child attributes
Show child attributes