Create a room from a template
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"recording_consent_receipt_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate"
payload = {
"name": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"recording_consent_receipt_id": "<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({
name: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
recording_consent_receipt_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate', 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/room-templates/{id}/instantiate",
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([
'name' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'recording_consent_receipt_id' => '<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/video/room-templates/{id}/instantiate"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<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.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate")
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 \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"room_id": "<string>",
"room_sid": "<string>",
"host_token": "<string>",
"ws_url": "<string>",
"template_id": "<string>",
"composite_egress_id": "<string>",
"track_egress_id": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Video
Create a room from a template
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.
POST
/
api
/
v1
/
video
/
room-templates
/
{id}
/
instantiate
Create a room from a template
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"recording_consent_receipt_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate"
payload = {
"name": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"recording_consent_receipt_id": "<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({
name: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
recording_consent_receipt_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate', 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/room-templates/{id}/instantiate",
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([
'name' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'recording_consent_receipt_id' => '<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/video/room-templates/{id}/instantiate"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<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.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}/instantiate")
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 \"name\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"recording_consent_receipt_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"room_id": "<string>",
"room_sid": "<string>",
"host_token": "<string>",
"ws_url": "<string>",
"template_id": "<string>",
"composite_egress_id": "<string>",
"track_egress_id": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
The vrtpl_-prefixed template id.
Body
application/json
Label for the new room (per-instance).
Required string length:
1 - 200Optional 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.
Required string length:
1 - 128⌘I