Video API

Video endpoints exposed by the Devotel CPaaS API Base path: /api/v1/video Endpoint count: 21

List avatar-agent personas

GET /api/v1/video/avatar-agents

List the calling tenant’s registered AI video-avatar-agent (‘digital human’) personas. Each persona binds one of the tenant’s existing conversational agents to a rendered-avatar provider (tavus / heygen / did) plus a display config, so the avatar-runtime can join a self-hosted WebRTC room as a talking-head participant. Read-only; scoped on video:read (or video:write as a superset).

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-agents" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-agents", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-agents", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Compose an avatar-agent join plan

GET /api/v1/video/avatar-agents/{id}/join-plan

Compose the deterministic dispatch descriptor the avatar-runtime consumes to join the given room as this persona. Read-only: it resolves the persona and composes the join contract; it does not mint the SFU token or call the avatar provider (the runtime does that with its own credentials). A disabled persona returns 409. Scoped on video:read (or video:write as a superset).

string

required

The vaa_-prefixed persona id.

string

required

Name of the WebRTC room the avatar will join.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}/join-plan');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

List avatar-video render jobs

GET /api/v1/video/avatar-video-renders

List the calling tenant’s async AI avatar video-message render jobs, newest first. Optionally filter by status or persona_id. Read-only; scoped on video:read (or video:write as a superset).

string (enum: queued|rendering|completed|failed)

Filter to render jobs in this lifecycle state.

string

Filter to render jobs scripted from this vaa_-prefixed persona.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Get an avatar-video render job

GET /api/v1/video/avatar-video-renders/{id}

Poll a single avatar-video render job’s status by its vavr_-prefixed id. Read-only; scoped on video:read (or video:write as a superset).

string

required

The vavr_-prefixed render job id.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

List room-config templates

GET /api/v1/video/room-templates

List the calling tenant’s saved reusable video room-config templates (‘meeting templates’). Each template stores a NON-SECRET room-config preset (participant cap, recording/egress defaults, media policy, E2EE, region, waiting-room lobby) that a new room can be created from via POST /:id/instantiate. Read-only; scoped on video:read (or video:write as a superset).

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/room-templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/room-templates", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/room-templates", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Get a room-config template

GET /api/v1/video/room-templates/{id}

Fetch a single saved room-config template by id. Read-only; scoped on video:read (or video:write as a superset).

string

required

The vrtpl_-prefixed template id.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Room usage analytics

GET /api/v1/video/rooms-analytics/usage

Aggregate video room usage + engagement for the calling tenant over a date window (default last 30 days): total sessions, room-minutes, average/peak concurrent participants, recording success rate, and join failures. Returns an org-wide summary plus a per-UTC-day daily time series for sessions-over-time charts. Read-only; scoped on video:read (or video:write as a superset).

string

Window start (ISO 8601 date-time). Defaults to 30 days before to.

string

Window end (ISO 8601 date-time). Defaults to now.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Register an avatar-agent persona

POST /api/v1/video/avatar-agents

Register a new AI video-avatar-agent persona for the calling tenant, binding an existing conversational agent to a rendered-avatar provider and display config. Owner/admin/developer only; scoped on video:write. Persona names must be unique within the tenant (case-insensitive) and the registry is capped per tenant.

string

required

Tenant-supplied label rendered in the picker. Unique within the tenant (case-insensitive).

string

required

The conversational agent that drives the dialog (agt_-prefixed).

string (enum: tavus|heygen|did)

required

Rendered-avatar provider this persona uses.

string

required

The tenant’s own opaque persona/replica reference id at that provider.

string | null

Optional opening line the avatar speaks on join.

string | null

Optional BCP-47-ish locale hint for TTS (e.g. en-US).

boolean

Whether the persona is dispatchable to rooms. Defaults to true.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/avatar-agents" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/avatar-agents", headers=headers, json={
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/avatar-agents", bytes.NewBuffer([]byte(`{
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "name": "string",
  "agent_id": "string",
  "provider": "tavus",
  "provider_persona_ref": "string"
}
JSON);
echo curl_exec($ch);

Script an avatar-video render job

POST /api/v1/video/avatar-video-renders

Script a new async avatar-video render job for an existing, enabled avatar persona — merges merge_fields into script_template and persists the request as a pollable job. Does not call the provider render API directly; the tenant’s render runtime performs the actual render and reports back via PATCH /api/v1/video/avatar-video-renders/. Owner/admin/developer only; scoped on video:write.

string

required

The vaa_-prefixed avatar persona to render from. Must be an existing, enabled persona.

string

required

The operator-authored script, with optional tokens.

string | null

Optional BCP-47-ish locale override for TTS; falls back to the persona’s locale when omitted.

object

Values for every referenced by script_template. A referenced token with no supplied value rejects the request.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "avatar_agent_id": "string",
  "script_template": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "avatar_agent_id": "string",
  "script_template": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", headers=headers, json={
  "avatar_agent_id": "string",
  "script_template": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", bytes.NewBuffer([]byte(`{
  "avatar_agent_id": "string",
  "script_template": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "avatar_agent_id": "string",
  "script_template": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "avatar_agent_id": "string",
  "script_template": "string"
}
JSON);
echo curl_exec($ch);

Create a room-config template

POST /api/v1/video/room-templates

Save a new reusable room-config template for the calling tenant. Owner/admin/developer only; scoped on video:write. Template names must be unique within the tenant (case-insensitive) and the library is capped at 100 templates per tenant. The config preset carries only non-secret room knobs — recording-storage credentials and consent receipts are never persisted on a template.

string

required

Tenant-supplied label rendered in the template picker. Unique within the tenant (case-insensitive).

string

Optional operator description.

any

required

—

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/room-templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "config": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "config": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/room-templates", headers=headers, json={
  "name": "string",
  "config": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/room-templates", bytes.NewBuffer([]byte(`{
  "name": "string",
  "config": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "name": "string",
  "config": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "name": "string",
  "config": "string"
}
JSON);
echo curl_exec($ch);

Create a room from a template

POST /api/v1/video/room-templates/{id}/instantiate

Create a live (or scheduled) video room from a saved template, mapping the template’s stored config onto the room-create path with the SAME per-tier participant-cap gate, required-captions deployment guard, media/E2EE/region knobs, waiting-room lobby, recording-consent gate + auto-start, inbox backlink, and audit trail as POST /video/rooms-scheduled. Owner/admin/developer only; scoped on video:write.

string

required

The vrtpl_-prefixed template id.

string

required

Label for the new room (per-instance).

string | null

Optional ISO 8601 date-time to schedule the room for; omit or null to create it live now.

Consent-receipt id threaded into the recording-consent gate when the template auto-starts a recording in a two-party-consent jurisdiction.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate", headers=headers, json={
  "name": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate", bytes.NewBuffer([]byte(`{
  "name": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "name": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "name": "string"
}
JSON);
echo curl_exec($ch);

Post a chat message into a video room

POST /api/v1/video/rooms-scheduled/{id}/chat

Broadcasts a chat message to every participant on the room’s orbit.chat data-channel topic. Any joined participant may post (mirrors reactions / Q&A) — an SDK bot or webinar viewer included. Chat is transient: the message is fanned out, never persisted, so there is no list to read back. The sender identity is SERVER-stamped from the auth context and is never a body field; the caller mints the message_id UUID so the stateless send → delete lifecycle correlates client-side. Scoped on video:read (or video:write as a superset).

string

required

Scheduled room id.

string

required

Client-minted UUID correlating the send → delete lifecycle.

string

required

The message text. The sender identity is never a body field — the server stamps it.

string

Optional message_id of the message being replied to (threaded replies).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat", headers=headers, json={
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat", bytes.NewBuffer([]byte(`{
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "message_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}
JSON);
echo curl_exec($ch);

Configure a video room’s chat content-safety policy

POST /api/v1/video/rooms-scheduled/{id}/chat-policy

Sets the room’s PROACTIVE chat content-safety policy — a pre-broadcast screen the send handler (POST /chat) applies BEFORE a message is fanned out or persisted. Under mode: block a matched message is rejected and never reaches another participant or the replay history; flag delivers it but marks it for moderator review; log delivers it unchanged and only records the match. Disabling the policy (enabled: false) preserves the default deliver-first behaviour. Host-only — requires the video:write role (owner | admin | developer) and is audited. Complements the reactive moderation endpoints (/chat/delete, /chat/clear).

string

required

Scheduled room id.

boolean

required

Master switch. When false the send handler behaves exactly as before (deliver-first).

string (enum: block|flag|log)

required

What to do with a matched message. block rejects it pre-broadcast; flag delivers-and-marks it for review; log delivers it unchanged and records the match.

string (enum: profanity|pii|toxicity)[]

required

Built-in content-safety categories to screen for (deduped server-side).

string[]

required

Operator-curated exact / word-boundary terms, applied whenever the policy is enabled regardless of categories.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy", headers=headers, json={
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy", bytes.NewBuffer([]byte(`{
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat-policy');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "enabled": false,
  "mode": "block",
  "categories": [],
  "custom_blocklist": []
}
JSON);
echo curl_exec($ch);

Clear the entire room chat (host-only)

POST /api/v1/video/rooms-scheduled/{id}/chat/clear

Host moderation action: broadcasts a clear event so every client hides all messages posted before the clear timestamp. Host-only — requires the video:write role (owner | admin | developer) and is audited. The moderator identity is SERVER-stamped from the auth context. Carries no body fields; a stray payload is rejected.

string

required

Scheduled room id.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/clear');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Delete a single chat message (host-only)

POST /api/v1/video/rooms-scheduled/{id}/chat/delete

Host moderation action: broadcasts a delete event so every client hides the message with the matching message_id. Host-only — requires the video:write role (owner | admin | developer) and is audited. The moderator identity is SERVER-stamped from the auth context, never a body field.

string

required

Scheduled room id.

string

required

The message to remove (matches a prior send’s message_id).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "message_id": "00000000-0000-0000-0000-000000000000"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "message_id": "00000000-0000-0000-0000-000000000000"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete", headers=headers, json={
  "message_id": "00000000-0000-0000-0000-000000000000"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete", bytes.NewBuffer([]byte(`{
  "message_id": "00000000-0000-0000-0000-000000000000"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "message_id": "00000000-0000-0000-0000-000000000000"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/chat/delete');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "message_id": "00000000-0000-0000-0000-000000000000"
}
JSON);
echo curl_exec($ch);

Update an avatar-agent persona

PATCH /api/v1/video/avatar-agents/{id}

Apply a partial update to an avatar persona. Only supplied fields change; a null greeting or locale clears it. Owner/admin/developer only; scoped on video:write.

string

required

The vaa_-prefixed persona id.

string

—

string

—

string (enum: tavus|heygen|did)

—

string

—

string | null

—

string | null

—

boolean

—

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Report an avatar-video render job’s status

PATCH /api/v1/video/avatar-video-renders/{id}

The render runtime’s callback reporting a job’s status transition once it has an outcome (e.g. an output clip URL, or a failure reason). Owner/admin/developer only; scoped on video:write.

string

required

The vavr_-prefixed render job id.

string (enum: rendering|completed|failed)

required

The new lifecycle state. Must be a valid transition from the job’s current status.

string

The rendered clip’s HTTPS URL. Required when transitioning to completed.

string

Human-readable failure reason. Set when transitioning to failed.

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "rendering"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "status": "rendering"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", headers=headers, json={
  "status": "rendering"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", bytes.NewBuffer([]byte(`{
  "status": "rendering"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "status": "rendering"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "status": "rendering"
}
JSON);
echo curl_exec($ch);

Update a room-config template

PATCH /api/v1/video/room-templates/{id}

Apply a partial update to a room-config template. At least one of name / description / config must be supplied; a null description clears it. config is a FULL replacement of the stored preset (validated in whole so the cross-field codec/SVC guard always runs), not a deep-merge. Owner/admin/developer only; scoped on video:write.

string

required

The vrtpl_-prefixed template id.

string

—

string | null

—

any

—

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Delete an avatar-agent persona

DELETE /api/v1/video/avatar-agents/{id}

Remove an avatar persona from the tenant’s registry. Owner/admin/developer only; scoped on video:write. A missing id returns 404, so a delete never silently no-ops a mistyped id.

string

required

The vaa_-prefixed persona id.

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Delete an avatar-video render job

DELETE /api/v1/video/avatar-video-renders/{id}

Remove a render job from history. A missing id returns 404, so a delete never silently no-ops a mistyped id. Owner/admin/developer only; scoped on video:write.

string

required

The vavr_-prefixed render job id.

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Delete a room-config template

DELETE /api/v1/video/room-templates/{id}

Remove a room-config template from the tenant’s library. Owner/admin/developer only; scoped on video:write. A missing id returns 404, so a delete never silently no-ops a mistyped id.

string

required

The vrtpl_-prefixed template id.

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

API Reference

All Endpoints

Video API

Video API

List avatar-agent personas

Compose an avatar-agent join plan

List avatar-video render jobs

Get an avatar-video render job

List room-config templates

Get a room-config template

Room usage analytics

Register an avatar-agent persona

Script an avatar-video render job

Create a room-config template

Create a room from a template

Post a chat message into a video room

Configure a video room’s chat content-safety policy

Clear the entire room chat (host-only)

Delete a single chat message (host-only)

Update an avatar-agent persona

Report an avatar-video render job’s status

Update a room-config template

Delete an avatar-agent persona

Delete an avatar-video render job

Delete a room-config template

​Video API

​List avatar-agent personas

​Compose an avatar-agent join plan

​List avatar-video render jobs

​Get an avatar-video render job

​List room-config templates

​Get a room-config template

​Room usage analytics

​Register an avatar-agent persona

​Script an avatar-video render job

​Create a room-config template

​Create a room from a template

​Post a chat message into a video room

​Configure a video room’s chat content-safety policy

​Clear the entire room chat (host-only)

​Delete a single chat message (host-only)

​Update an avatar-agent persona

​Report an avatar-video render job’s status

​Update a room-config template

​Delete an avatar-agent persona

​Delete an avatar-video render job

​Delete a room-config template

Video API

List avatar-agent personas

Compose an avatar-agent join plan

List avatar-video render jobs

Get an avatar-video render job

List room-config templates

Get a room-config template

Room usage analytics

Register an avatar-agent persona

Script an avatar-video render job

Create a room-config template

Create a room from a template

Post a chat message into a video room

Configure a video room’s chat content-safety policy

Clear the entire room chat (host-only)

Delete a single chat message (host-only)

Update an avatar-agent persona

Report an avatar-video render job’s status

Update a room-config template

Delete an avatar-agent persona

Delete an avatar-video render job

Delete a room-config template