Create a built-in Voice AI WebRTC preview session

Served by the Voice API. Requires a Bearer session for a workspace owner/admin/manager when the V2 flag is enabled. Accepts unsaved turn settings when opted in. Uses automatic WebRTC response control rather than phone bridge control. Returns a short-lived client secret; never log or cache the response. include_api_tools=true additionally requires an owner/admin Bearer JWT and both VOICE_AI_API_TOOLS and VOICE_AI_TELEPHONY_TURN_CONTROL_V2. It advertises enabled saved tools and returns tool_preview.ticket plus names; the signed binding expires after 15 minutes and authorizes real API test actions.

POST

https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/preview/realtime/session

Path parameters

workspaceId
string
required

Request body JSON

turn_detection_mode
optional
server_vad
or
semantic_vad
turn_detection_eagerness
optional
low
or
medium
or
high
or
auto
turn_detection_threshold
optional
number
maximum: 0.85 · minimum: 0.35
silence_duration_ms
optional
number
maximum: 1500 · minimum: 300
prefix_padding_ms
optional
number
maximum: 1000 · minimum: 100
barge_in_enabled
optional
boolean
include_api_tools
optional
boolean
default: false

Returns

200

Realtime preview client secret

400

Missing provider configuration or invalid turn settings

401

Missing or invalid JWT for tool-enabled preview

403

Workspace membership or feature requirements not met

500

Session creation failed

503

Tool preview service unavailable

Create a built-in Voice AI WebRTC preview session

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/preview/realtime/session' \
  --header 'Content-Type: application/json' \
  --data '
{
  "turn_detection_mode": "server_vad",
  "turn_detection_eagerness": "low",
  "turn_detection_threshold": 0.35,
  "silence_duration_ms": 300,
  "prefix_padding_ms": 100,
  "barge_in_enabled": true,
  "include_api_tools": false
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/preview/realtime/session';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    turn_detection_mode: 'server_vad',
    turn_detection_eagerness: 'low',
    turn_detection_threshold: 0.35,
    silence_duration_ms: 300,
    prefix_padding_ms: 100,
    barge_in_enabled: true,
    include_api_tools: false
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/preview/realtime/session"

payload = {
    "turn_detection_mode": "server_vad",
    "turn_detection_eagerness": "low",
    "turn_detection_threshold": 0.35,
    "silence_duration_ms": 300,
    "prefix_padding_ms": 100,
    "barge_in_enabled": True,
    "include_api_tools": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)