curl --request POST \
--url https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"timezone": "UTC"
}
'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions"
payload = {
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"timezone": "UTC"
}
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({
conversationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
userId: '<string>',
timezone: 'UTC'
})
};
fetch('https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions', 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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions",
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([
'conversationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'userId' => '<string>',
'timezone' => 'UTC'
]),
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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions"
payload := strings.NewReader("{\n \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions")
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 \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"participantToken": "<string>",
"sessionId": "<string>",
"roomName": "<string>",
"maxDurationSeconds": 123,
"conversationId": "<string>",
"userId": "<string>"
}
}{
"error": {
"code": "VALIDATION_INVALID_BODY",
"message": "Invalid request"
}
}{
"error": {
"code": "AUTH_MISSING_API_KEY",
"message": "Authentication required"
}
}{
"error": {
"code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
"message": "A Standard plan or higher is required to access the API"
}
}{
"error": {
"code": "AGENT_NOT_FOUND",
"message": "Agent not found"
}
}{
"error": {
"code": "RATE_LIMIT_TOO_MANY_REQUESTS",
"message": "Too many requests, please try again later"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Something went wrong, please try again"
}
}{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}Start a voice session
Create a real-time voice session for an agent. Pass the response data to the Chatbase Voice SDK (@chatbase-co/voice-sdk) in your client: the SDK connects, publishes the microphone, and the agent joins automatically. Requires a plan with voice mode enabled; voice minutes consume message credits. Send {} when no options are needed.
curl --request POST \
--url https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"timezone": "UTC"
}
'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions"
payload = {
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"timezone": "UTC"
}
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({
conversationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
userId: '<string>',
timezone: 'UTC'
})
};
fetch('https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions', 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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions",
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([
'conversationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'userId' => '<string>',
'timezone' => 'UTC'
]),
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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions"
payload := strings.NewReader("{\n \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\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://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}/voice/sessions")
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 \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userId\": \"<string>\",\n \"timezone\": \"UTC\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"participantToken": "<string>",
"sessionId": "<string>",
"roomName": "<string>",
"maxDurationSeconds": 123,
"conversationId": "<string>",
"userId": "<string>"
}
}{
"error": {
"code": "VALIDATION_INVALID_BODY",
"message": "Invalid request"
}
}{
"error": {
"code": "AUTH_MISSING_API_KEY",
"message": "Authentication required"
}
}{
"error": {
"code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
"message": "A Standard plan or higher is required to access the API"
}
}{
"error": {
"code": "AGENT_NOT_FOUND",
"message": "Agent not found"
}
}{
"error": {
"code": "RATE_LIMIT_TOO_MANY_REQUESTS",
"message": "Too many requests, please try again later"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Something went wrong, please try again"
}
}{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}Authorizations
API key from your account settings
Path Parameters
The agent ID
1"5QHA6VB-DIAbBhxwqxfdi"
Body
Optional conversation UUID. Reuse a value to group multiple voice sessions into one conversation in chat logs. If omitted, a new conversation is created.
Your end-user ID. Send a stable ID so per-user voice limits apply; if omitted a random one is generated per session. Must contain only URL-safe characters (letters, digits, hyphens, underscores, dots).
128^[a-zA-Z0-9._-]+$IANA timezone of the end user (e.g. "Europe/Paris"), used by the agent for time-aware answers. Defaults to UTC.
64Response
Voice session created
Show child attributes
Show child attributes
