Start a browser WebRTC session
Creates a browser voice session and returns a room URL plus a one-time access token your browser uses to connect to the agent in real time.
The session is fully tracked on the platform — when the session ends, the same session.completed webhook fires (transcript, recording_url, extraction). The webhook payload’s call field is omitted for these sessions because there is no associated phone call. See Web Voice Testing for end-to-end browser integration code.
Auth + limits: Bearer API key (rg_live_*). Bound by the API key’s concurrency limit. Rate-limited to 10 starts/minute per key.
curl --request POST \
--url https://api.vocobase.com/api/v2/sessions/webrtc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {
"callee_name": "Sajal"
}
}
'import requests
url = "https://api.vocobase.com/api/v2/sessions/webrtc"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": { "callee_name": "Sajal" }
}
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({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {callee_name: 'Sajal'}
})
};
fetch('https://api.vocobase.com/api/v2/sessions/webrtc', 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.vocobase.com/api/v2/sessions/webrtc",
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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variables' => [
'callee_name' => 'Sajal'
]
]),
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.vocobase.com/api/v2/sessions/webrtc"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\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.vocobase.com/api/v2/sessions/webrtc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/sessions/webrtc")
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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"session_id": "s1234567-abcd-1234-abcd-123456789012",
"agent_id": "a1234567-abcd-1234-abcd-123456789012",
"daily_room_url": "https://voice-session.example.com/abc123",
"daily_token": "eyJhbGciOi..."
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"success": false,
"error": {
"code": "CONCURRENCY_LIMIT_EXCEEDED",
"message": "Concurrency limit reached. Maximum simultaneous sessions exceeded."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}{
"success": false,
"error": {
"code": "BOT_SERVER_UNAVAILABLE",
"message": "Voice session temporarily unavailable. Please try again."
}
}Authorizations
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
Body
ID of the agent to use for this session.
Pre-call variable values. Keys must match variable names declared on the agent (Agent.variables). Substituted into the agent's prompt and greeting via {{name}} placeholders. Echoed in the session.completed webhook for your own audit. Missing variables render as empty strings.
Show child attributes
Show child attributes
{ "callee_name": "Sajal" }
curl --request POST \
--url https://api.vocobase.com/api/v2/sessions/webrtc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {
"callee_name": "Sajal"
}
}
'import requests
url = "https://api.vocobase.com/api/v2/sessions/webrtc"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": { "callee_name": "Sajal" }
}
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({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {callee_name: 'Sajal'}
})
};
fetch('https://api.vocobase.com/api/v2/sessions/webrtc', 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.vocobase.com/api/v2/sessions/webrtc",
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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variables' => [
'callee_name' => 'Sajal'
]
]),
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.vocobase.com/api/v2/sessions/webrtc"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\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.vocobase.com/api/v2/sessions/webrtc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/sessions/webrtc")
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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {\n \"callee_name\": \"Sajal\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"session_id": "s1234567-abcd-1234-abcd-123456789012",
"agent_id": "a1234567-abcd-1234-abcd-123456789012",
"daily_room_url": "https://voice-session.example.com/abc123",
"daily_token": "eyJhbGciOi..."
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"success": false,
"error": {
"code": "CONCURRENCY_LIMIT_EXCEEDED",
"message": "Concurrency limit reached. Maximum simultaneous sessions exceeded."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}{
"success": false,
"error": {
"code": "BOT_SERVER_UNAVAILABLE",
"message": "Voice session temporarily unavailable. Please try again."
}
}