Create an agent
curl --request POST \
--url https://api.brilo.ai/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"call_handling": {
"greeting_interruptible": true,
"idle_reminder": {
"after_seconds": 300,
"enabled": true,
"message": "<string>"
},
"max_duration_seconds": 7200,
"silence_timeout_seconds": 300
},
"greeting": "<string>",
"instructions": "<string>",
"languages": [
"<string>"
],
"recording": {
"consent": {
"prompt": "<string>"
},
"enabled": true,
"transcript_enabled": true
},
"timezone": "<string>",
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"speaking_rate": 0.8
},
"voicemail": {
"message": "<string>"
}
},
"description": "<string>"
}
'import requests
url = "https://api.brilo.ai/v1/agents"
payload = {
"name": "<string>",
"config": {
"call_handling": {
"greeting_interruptible": True,
"idle_reminder": {
"after_seconds": 300,
"enabled": True,
"message": "<string>"
},
"max_duration_seconds": 7200,
"silence_timeout_seconds": 300
},
"greeting": "<string>",
"instructions": "<string>",
"languages": ["<string>"],
"recording": {
"consent": { "prompt": "<string>" },
"enabled": True,
"transcript_enabled": True
},
"timezone": "<string>",
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"speaking_rate": 0.8
},
"voicemail": { "message": "<string>" }
},
"description": "<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>',
config: {
call_handling: {
greeting_interruptible: true,
idle_reminder: {after_seconds: 300, enabled: true, message: '<string>'},
max_duration_seconds: 7200,
silence_timeout_seconds: 300
},
greeting: '<string>',
instructions: '<string>',
languages: ['<string>'],
recording: {consent: {prompt: '<string>'}, enabled: true, transcript_enabled: true},
timezone: '<string>',
voice: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', speaking_rate: 0.8},
voicemail: {message: '<string>'}
},
description: '<string>'
})
};
fetch('https://api.brilo.ai/v1/agents', 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.brilo.ai/v1/agents",
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>',
'config' => [
'call_handling' => [
'greeting_interruptible' => true,
'idle_reminder' => [
'after_seconds' => 300,
'enabled' => true,
'message' => '<string>'
],
'max_duration_seconds' => 7200,
'silence_timeout_seconds' => 300
],
'greeting' => '<string>',
'instructions' => '<string>',
'languages' => [
'<string>'
],
'recording' => [
'consent' => [
'prompt' => '<string>'
],
'enabled' => true,
'transcript_enabled' => true
],
'timezone' => '<string>',
'voice' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'speaking_rate' => 0.8
],
'voicemail' => [
'message' => '<string>'
]
],
'description' => '<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.brilo.ai/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<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.brilo.ai/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brilo.ai/v1/agents")
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 \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"call_handling": {
"greeting_interruptible": true,
"idle_reminder": {
"after_seconds": 0,
"enabled": true,
"message": "<string>"
},
"max_duration_seconds": 0,
"silence_timeout_seconds": 0
},
"greeting": "<string>",
"instructions": "<string>",
"languages": [
"<string>"
],
"model": {
"id": "<string>"
},
"recording": {
"consent": {
"prompt": "<string>",
"type": "<string>"
},
"enabled": true,
"transcript_enabled": true
},
"timezone": "<string>",
"transcriber": {
"id": "<string>"
},
"voice": {
"id": "<string>",
"speaking_rate": 123
},
"voicemail": {
"behavior": "<string>",
"message": "<string>"
}
},
"created_at": "<string>",
"description": "<string>",
"draft_pending": true,
"id": "<string>",
"live_version_id": "<string>",
"name": "<string>",
"phone_numbers": [
"<string>"
],
"revision": "<string>",
"versioning_enabled": true,
"changed_fields": [
"<string>"
],
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
},
"try_it": {
"phone_numbers": [
"<string>"
],
"ring_me": {
"ask_owner_first": "<string>",
"body": {
"agent_id": "<string>",
"to": "<string>"
},
"method": "POST",
"path": "/v1/call",
"tool": null,
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"web_link": "<string>",
"web_link_serves": "live"
},
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}Agents and versions
Create an agent
Creates an agent with a live version “main” whose first commit is config, filled in from your plan defaults for anything you leave out. Callers can reach it as soon as a phone number is attached.
POST
/
agents
Create an agent
curl --request POST \
--url https://api.brilo.ai/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"call_handling": {
"greeting_interruptible": true,
"idle_reminder": {
"after_seconds": 300,
"enabled": true,
"message": "<string>"
},
"max_duration_seconds": 7200,
"silence_timeout_seconds": 300
},
"greeting": "<string>",
"instructions": "<string>",
"languages": [
"<string>"
],
"recording": {
"consent": {
"prompt": "<string>"
},
"enabled": true,
"transcript_enabled": true
},
"timezone": "<string>",
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"speaking_rate": 0.8
},
"voicemail": {
"message": "<string>"
}
},
"description": "<string>"
}
'import requests
url = "https://api.brilo.ai/v1/agents"
payload = {
"name": "<string>",
"config": {
"call_handling": {
"greeting_interruptible": True,
"idle_reminder": {
"after_seconds": 300,
"enabled": True,
"message": "<string>"
},
"max_duration_seconds": 7200,
"silence_timeout_seconds": 300
},
"greeting": "<string>",
"instructions": "<string>",
"languages": ["<string>"],
"recording": {
"consent": { "prompt": "<string>" },
"enabled": True,
"transcript_enabled": True
},
"timezone": "<string>",
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"speaking_rate": 0.8
},
"voicemail": { "message": "<string>" }
},
"description": "<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>',
config: {
call_handling: {
greeting_interruptible: true,
idle_reminder: {after_seconds: 300, enabled: true, message: '<string>'},
max_duration_seconds: 7200,
silence_timeout_seconds: 300
},
greeting: '<string>',
instructions: '<string>',
languages: ['<string>'],
recording: {consent: {prompt: '<string>'}, enabled: true, transcript_enabled: true},
timezone: '<string>',
voice: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', speaking_rate: 0.8},
voicemail: {message: '<string>'}
},
description: '<string>'
})
};
fetch('https://api.brilo.ai/v1/agents', 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.brilo.ai/v1/agents",
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>',
'config' => [
'call_handling' => [
'greeting_interruptible' => true,
'idle_reminder' => [
'after_seconds' => 300,
'enabled' => true,
'message' => '<string>'
],
'max_duration_seconds' => 7200,
'silence_timeout_seconds' => 300
],
'greeting' => '<string>',
'instructions' => '<string>',
'languages' => [
'<string>'
],
'recording' => [
'consent' => [
'prompt' => '<string>'
],
'enabled' => true,
'transcript_enabled' => true
],
'timezone' => '<string>',
'voice' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'speaking_rate' => 0.8
],
'voicemail' => [
'message' => '<string>'
]
],
'description' => '<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.brilo.ai/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<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.brilo.ai/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brilo.ai/v1/agents")
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 \"config\": {\n \"call_handling\": {\n \"greeting_interruptible\": true,\n \"idle_reminder\": {\n \"after_seconds\": 300,\n \"enabled\": true,\n \"message\": \"<string>\"\n },\n \"max_duration_seconds\": 7200,\n \"silence_timeout_seconds\": 300\n },\n \"greeting\": \"<string>\",\n \"instructions\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"recording\": {\n \"consent\": {\n \"prompt\": \"<string>\"\n },\n \"enabled\": true,\n \"transcript_enabled\": true\n },\n \"timezone\": \"<string>\",\n \"voice\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"speaking_rate\": 0.8\n },\n \"voicemail\": {\n \"message\": \"<string>\"\n }\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"call_handling": {
"greeting_interruptible": true,
"idle_reminder": {
"after_seconds": 0,
"enabled": true,
"message": "<string>"
},
"max_duration_seconds": 0,
"silence_timeout_seconds": 0
},
"greeting": "<string>",
"instructions": "<string>",
"languages": [
"<string>"
],
"model": {
"id": "<string>"
},
"recording": {
"consent": {
"prompt": "<string>",
"type": "<string>"
},
"enabled": true,
"transcript_enabled": true
},
"timezone": "<string>",
"transcriber": {
"id": "<string>"
},
"voice": {
"id": "<string>",
"speaking_rate": 123
},
"voicemail": {
"behavior": "<string>",
"message": "<string>"
}
},
"created_at": "<string>",
"description": "<string>",
"draft_pending": true,
"id": "<string>",
"live_version_id": "<string>",
"name": "<string>",
"phone_numbers": [
"<string>"
],
"revision": "<string>",
"versioning_enabled": true,
"changed_fields": [
"<string>"
],
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
},
"try_it": {
"phone_numbers": [
"<string>"
],
"ring_me": {
"ask_owner_first": "<string>",
"body": {
"agent_id": "<string>",
"to": "<string>"
},
"method": "POST",
"path": "/v1/call",
"tool": null,
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"web_link": "<string>",
"web_link_serves": "live"
},
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}Authorizations
Enter your API key (Bearer token)
Headers
Optional. A retry with the same key and body returns the first response instead of doing the work twice.
Body
application/json
Response
What callers hear now: the live version, latest commit.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Ways to hear the live agent now. Left out when nothing is callable.
Show child attributes
Show child attributes
Show child attributes
Show child attributes