curl --request POST \
--url https://api.orbit.devotel.io/api/v1/video/avatar-video-renders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"avatar_agent_id": "<string>",
"script_template": "<string>",
"locale": "<string>",
"merge_fields": {}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders"
payload = {
"avatar_agent_id": "<string>",
"script_template": "<string>",
"locale": "<string>",
"merge_fields": {}
}
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({
avatar_agent_id: '<string>',
script_template: '<string>',
locale: '<string>',
merge_fields: {}
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', 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/video/avatar-video-renders",
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([
'avatar_agent_id' => '<string>',
'script_template' => '<string>',
'locale' => '<string>',
'merge_fields' => [
]
]),
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/video/avatar-video-renders"
payload := strings.NewReader("{\n \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\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/video/avatar-video-renders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders")
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 \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"render": {
"id": "<string>",
"persona_id": "<string>",
"script_template": "<string>",
"merge_fields": {},
"rendered_script": "<string>",
"locale": "<string>",
"output_url": "<string>",
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Script an avatar-video render job
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.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/video/avatar-video-renders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"avatar_agent_id": "<string>",
"script_template": "<string>",
"locale": "<string>",
"merge_fields": {}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders"
payload = {
"avatar_agent_id": "<string>",
"script_template": "<string>",
"locale": "<string>",
"merge_fields": {}
}
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({
avatar_agent_id: '<string>',
script_template: '<string>',
locale: '<string>',
merge_fields: {}
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', 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/video/avatar-video-renders",
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([
'avatar_agent_id' => '<string>',
'script_template' => '<string>',
'locale' => '<string>',
'merge_fields' => [
]
]),
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/video/avatar-video-renders"
payload := strings.NewReader("{\n \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\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/video/avatar-video-renders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders")
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 \"avatar_agent_id\": \"<string>\",\n \"script_template\": \"<string>\",\n \"locale\": \"<string>\",\n \"merge_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"render": {
"id": "<string>",
"persona_id": "<string>",
"script_template": "<string>",
"merge_fields": {},
"rendered_script": "<string>",
"locale": "<string>",
"output_url": "<string>",
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Body
The vaa_-prefixed avatar persona to render from. Must be an existing, enabled persona.
1 - 64The operator-authored script, with optional {{merge_field}} tokens.
1 - 5000Optional BCP-47-ish locale override for TTS; falls back to the persona's locale when omitted.
35Values for every {{token}} referenced by script_template. A referenced token with no supplied value rejects the request.
Show child attributes
Show child attributes