cURL
curl --request POST \
--url https://api.comm.com/api/v1/voice/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": [
"<string>"
],
"post_processing_agents": [
"<string>"
],
"variables": [
"<string>"
],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": false,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": false,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": true,
"speaking_plan_num_words": 3,
"allow_interruptions": true,
"pixel_is_lead": false,
"pixel_is_sale": false,
"pixel_sale_amount": 0
}
'import requests
url = "https://api.comm.com/api/v1/voice/agents"
payload = {
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": ["<string>"],
"post_processing_agents": ["<string>"],
"variables": ["<string>"],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": False,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": False,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": True,
"speaking_plan_num_words": 3,
"allow_interruptions": True,
"pixel_is_lead": False,
"pixel_is_sale": False,
"pixel_sale_amount": 0
}
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>',
greeting_message: '<string>',
prompt: '<string>',
tools: ['<string>'],
post_processing_agents: ['<string>'],
variables: ['<string>'],
voice_id: '<string>',
voice_name: '<string>',
gpt_model_id: '<string>',
language: 'multi',
time_limit: 120,
start_with_greeting: false,
millis_sip_endpoint: '<string>',
voice_speed: 1,
voice_volume: 1,
background_noise: false,
suggestion_reason: '<string>',
provider: 'openai',
model: 'gpt-4o',
voice_provider: 'vapi',
voice_model: 'eleven_turbo_v2',
agent_description: '<string>',
silence_timeout_seconds: 15,
voice_mail_detection: true,
speaking_plan_num_words: 3,
allow_interruptions: true,
pixel_is_lead: false,
pixel_is_sale: false,
pixel_sale_amount: 0
})
};
fetch('https://api.comm.com/api/v1/voice/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.comm.com/api/v1/voice/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>',
'greeting_message' => '<string>',
'prompt' => '<string>',
'tools' => [
'<string>'
],
'post_processing_agents' => [
'<string>'
],
'variables' => [
'<string>'
],
'voice_id' => '<string>',
'voice_name' => '<string>',
'gpt_model_id' => '<string>',
'language' => 'multi',
'time_limit' => 120,
'start_with_greeting' => false,
'millis_sip_endpoint' => '<string>',
'voice_speed' => 1,
'voice_volume' => 1,
'background_noise' => false,
'suggestion_reason' => '<string>',
'provider' => 'openai',
'model' => 'gpt-4o',
'voice_provider' => 'vapi',
'voice_model' => 'eleven_turbo_v2',
'agent_description' => '<string>',
'silence_timeout_seconds' => 15,
'voice_mail_detection' => true,
'speaking_plan_num_words' => 3,
'allow_interruptions' => true,
'pixel_is_lead' => false,
'pixel_is_sale' => false,
'pixel_sale_amount' => 0
]),
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.comm.com/api/v1/voice/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\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.comm.com/api/v1/voice/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.comm.com/api/v1/voice/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 \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"meta": {
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": [
"<string>"
],
"post_processing_agents": [
"<string>"
],
"variables": [
"<string>"
],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": false,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": false,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": true,
"speaking_plan_num_words": 3,
"allow_interruptions": true,
"pixel_is_lead": false,
"pixel_is_sale": false,
"pixel_sale_amount": 0
},
"default_voice": {
"id": "<string>",
"name": "Eric"
},
"prompts": [
{
"id": "<string>",
"agent_id": "<string>",
"welcome_message": "<string>",
"prompt": "<string>",
"voice_id": "<string>",
"voice_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"team_id": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "Failed to create agent"
}Agents
Post v1voiceagents
POST
/
v1
/
voice
/
agents
cURL
curl --request POST \
--url https://api.comm.com/api/v1/voice/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": [
"<string>"
],
"post_processing_agents": [
"<string>"
],
"variables": [
"<string>"
],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": false,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": false,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": true,
"speaking_plan_num_words": 3,
"allow_interruptions": true,
"pixel_is_lead": false,
"pixel_is_sale": false,
"pixel_sale_amount": 0
}
'import requests
url = "https://api.comm.com/api/v1/voice/agents"
payload = {
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": ["<string>"],
"post_processing_agents": ["<string>"],
"variables": ["<string>"],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": False,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": False,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": True,
"speaking_plan_num_words": 3,
"allow_interruptions": True,
"pixel_is_lead": False,
"pixel_is_sale": False,
"pixel_sale_amount": 0
}
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>',
greeting_message: '<string>',
prompt: '<string>',
tools: ['<string>'],
post_processing_agents: ['<string>'],
variables: ['<string>'],
voice_id: '<string>',
voice_name: '<string>',
gpt_model_id: '<string>',
language: 'multi',
time_limit: 120,
start_with_greeting: false,
millis_sip_endpoint: '<string>',
voice_speed: 1,
voice_volume: 1,
background_noise: false,
suggestion_reason: '<string>',
provider: 'openai',
model: 'gpt-4o',
voice_provider: 'vapi',
voice_model: 'eleven_turbo_v2',
agent_description: '<string>',
silence_timeout_seconds: 15,
voice_mail_detection: true,
speaking_plan_num_words: 3,
allow_interruptions: true,
pixel_is_lead: false,
pixel_is_sale: false,
pixel_sale_amount: 0
})
};
fetch('https://api.comm.com/api/v1/voice/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.comm.com/api/v1/voice/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>',
'greeting_message' => '<string>',
'prompt' => '<string>',
'tools' => [
'<string>'
],
'post_processing_agents' => [
'<string>'
],
'variables' => [
'<string>'
],
'voice_id' => '<string>',
'voice_name' => '<string>',
'gpt_model_id' => '<string>',
'language' => 'multi',
'time_limit' => 120,
'start_with_greeting' => false,
'millis_sip_endpoint' => '<string>',
'voice_speed' => 1,
'voice_volume' => 1,
'background_noise' => false,
'suggestion_reason' => '<string>',
'provider' => 'openai',
'model' => 'gpt-4o',
'voice_provider' => 'vapi',
'voice_model' => 'eleven_turbo_v2',
'agent_description' => '<string>',
'silence_timeout_seconds' => 15,
'voice_mail_detection' => true,
'speaking_plan_num_words' => 3,
'allow_interruptions' => true,
'pixel_is_lead' => false,
'pixel_is_sale' => false,
'pixel_sale_amount' => 0
]),
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.comm.com/api/v1/voice/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\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.comm.com/api/v1/voice/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.comm.com/api/v1/voice/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 \"greeting_message\": \"<string>\",\n \"prompt\": \"<string>\",\n \"tools\": [\n \"<string>\"\n ],\n \"post_processing_agents\": [\n \"<string>\"\n ],\n \"variables\": [\n \"<string>\"\n ],\n \"voice_id\": \"<string>\",\n \"voice_name\": \"<string>\",\n \"gpt_model_id\": \"<string>\",\n \"language\": \"multi\",\n \"time_limit\": 120,\n \"start_with_greeting\": false,\n \"millis_sip_endpoint\": \"<string>\",\n \"voice_speed\": 1,\n \"voice_volume\": 1,\n \"background_noise\": false,\n \"suggestion_reason\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"gpt-4o\",\n \"voice_provider\": \"vapi\",\n \"voice_model\": \"eleven_turbo_v2\",\n \"agent_description\": \"<string>\",\n \"silence_timeout_seconds\": 15,\n \"voice_mail_detection\": true,\n \"speaking_plan_num_words\": 3,\n \"allow_interruptions\": true,\n \"pixel_is_lead\": false,\n \"pixel_is_sale\": false,\n \"pixel_sale_amount\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"meta": {
"name": "<string>",
"greeting_message": "<string>",
"prompt": "<string>",
"tools": [
"<string>"
],
"post_processing_agents": [
"<string>"
],
"variables": [
"<string>"
],
"voice_id": "<string>",
"voice_name": "<string>",
"gpt_model_id": "<string>",
"language": "multi",
"time_limit": 120,
"start_with_greeting": false,
"millis_sip_endpoint": "<string>",
"voice_speed": 1,
"voice_volume": 1,
"background_noise": false,
"suggestion_reason": "<string>",
"provider": "openai",
"model": "gpt-4o",
"voice_provider": "vapi",
"voice_model": "eleven_turbo_v2",
"agent_description": "<string>",
"silence_timeout_seconds": 15,
"voice_mail_detection": true,
"speaking_plan_num_words": 3,
"allow_interruptions": true,
"pixel_is_lead": false,
"pixel_is_sale": false,
"pixel_sale_amount": 0
},
"default_voice": {
"id": "<string>",
"name": "Eric"
},
"prompts": [
{
"id": "<string>",
"agent_id": "<string>",
"welcome_message": "<string>",
"prompt": "<string>",
"voice_id": "<string>",
"voice_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"team_id": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "Failed to create agent"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
AgentMetaDataRequest
Required range:
x >= 1Required range:
0 <= x <= 2Required range:
0 <= x <= 2Required range:
1 <= x <= 3600Required range:
1 <= x <= 10Response
AgentResource
Show child attributes
Show child attributes
⌘I