Create Conversation (Browser / Chat)
curl --request POST \
--url https://api.example.com/api/v1/agents/{agent_id}/conversations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mode": "webrtc",
"name": "test-1",
"initial_context": {
"first_name": "Anna"
}
}
'import requests
url = "https://api.example.com/api/v1/agents/{agent_id}/conversations"
payload = {
"mode": "webrtc",
"name": "test-1",
"initial_context": { "first_name": "Anna" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({mode: 'webrtc', name: 'test-1', initial_context: {first_name: 'Anna'}})
};
fetch('https://api.example.com/api/v1/agents/{agent_id}/conversations', 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.example.com/api/v1/agents/{agent_id}/conversations",
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([
'mode' => 'webrtc',
'name' => 'test-1',
'initial_context' => [
'first_name' => 'Anna'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/v1/agents/{agent_id}/conversations"
payload := strings.NewReader("{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/v1/agents/{agent_id}/conversations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agents/{agent_id}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"workflow_id": 123,
"name": "<string>",
"mode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"definition_id": 123,
"initial_context": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Agents & Calls
Create Conversation (Browser / Chat)
Create a conversation record for a browser (WebRTC) or chat session. This does not place a phone call: use POST /agents/{agent_id}/calls (or the agent’s API trigger), which takes phone_number and initial_context.
POST
/
api
/
v1
/
agents
/
{agent_id}
/
conversations
Create Conversation (Browser / Chat)
curl --request POST \
--url https://api.example.com/api/v1/agents/{agent_id}/conversations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mode": "webrtc",
"name": "test-1",
"initial_context": {
"first_name": "Anna"
}
}
'import requests
url = "https://api.example.com/api/v1/agents/{agent_id}/conversations"
payload = {
"mode": "webrtc",
"name": "test-1",
"initial_context": { "first_name": "Anna" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({mode: 'webrtc', name: 'test-1', initial_context: {first_name: 'Anna'}})
};
fetch('https://api.example.com/api/v1/agents/{agent_id}/conversations', 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.example.com/api/v1/agents/{agent_id}/conversations",
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([
'mode' => 'webrtc',
'name' => 'test-1',
'initial_context' => [
'first_name' => 'Anna'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/v1/agents/{agent_id}/conversations"
payload := strings.NewReader("{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/v1/agents/{agent_id}/conversations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agents/{agent_id}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"webrtc\",\n \"name\": \"test-1\",\n \"initial_context\": {\n \"first_name\": \"Anna\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"workflow_id": 123,
"name": "<string>",
"mode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"definition_id": 123,
"initial_context": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).
Path Parameters
The agent's ID: the public agent_ + 20 characters identifier shown in the dashboard (recommended), or the legacy number. Both address the same agent.
Pattern:
^agent_[A-Za-z0-9]{20}$Example:
"agent_7fK2mQ9xLp3RtV8wYb1N"
Body
application/json
A conversation record for a browser or chat session. It does not dial anyone.
Where the conversation will take place. webrtc or smallwebrtc for a voice session in the browser (what the dashboard's test call uses), chat for a text session. Telephony values are accepted for compatibility but only create a record - to place a phone call use POST /agents/{agent_id}/calls.
Example:
"webrtc"
Your label for the conversation.
Example:
"test-1"
Variables the agent can use as {{initial_context.}} in its prompts. Merged over the agent's own default variables.
Example:
{ "first_name": "Anna" }