Create a voice agent
curl --request POST \
--url https://api.cloudtalk.io/v1/voice-agents \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": [
"<string>"
],
"backgroundSound": {
"isCrossfadeLoopEnabled": true,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": [
"<string>"
],
"interruptionIgnoreTerms": [
"<string>"
],
"isSpeculativeTurnEnabled": true,
"isVadEnabled": true
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": true,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": true,
"knowledgeBaseIds": [
"<string>"
],
"scenarios": [
{
"isEnabled": true,
"reply": "<string>",
"actionParameters": {},
"toolId": "<string>",
"when": "<string>"
}
],
"secondaryLanguages": [
"<string>"
],
"skills": {
"answerQuestions": {
"isEnabled": true,
"transferConfig": {
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": true,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": true,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": true,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": true,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": true,
"rules": [
{
"condition": "<string>",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [],
"isConfirmationRequired": true
}
},
"status": "enabled",
"tone": []
}
'import requests
url = "https://api.cloudtalk.io/v1/voice-agents"
payload = {
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": ["<string>"],
"backgroundSound": {
"isCrossfadeLoopEnabled": True,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": ["<string>"],
"interruptionIgnoreTerms": ["<string>"],
"isSpeculativeTurnEnabled": True,
"isVadEnabled": True
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": True,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": True,
"knowledgeBaseIds": ["<string>"],
"scenarios": [
{
"isEnabled": True,
"reply": "<string>",
"actionParameters": {},
"toolId": "<string>",
"when": "<string>"
}
],
"secondaryLanguages": ["<string>"],
"skills": {
"answerQuestions": {
"isEnabled": True,
"transferConfig": {
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": True,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": True,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": True,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": True,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": True,
"rules": [
{
"condition": "<string>",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [],
"isConfirmationRequired": True
}
},
"status": "enabled",
"tone": []
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Receptionist',
defaultOutboundNumberId: 73836,
direction: 'inbound',
goalPrompt: '<string>',
language: 'en',
maxCallDurationMinutes: 30,
optimizeStreamingLatency: 2,
similarity: 0.5,
stability: 0.5,
temperature: 0.5,
voiceId: 'cgSgspJ2msm6clMCkdW9',
dialTimeoutSeconds: 62,
elevenLabsSettings: {
asrKeywords: ['<string>'],
backgroundSound: {isCrossfadeLoopEnabled: true, volume: 0.5},
interruptionIgnoreTermLanguages: ['<string>'],
interruptionIgnoreTerms: ['<string>'],
isSpeculativeTurnEnabled: true,
isVadEnabled: true
},
failoverOutboundNumberId: 73836,
greeting: '<string>',
guardrails: [{isEnabled: true, reply: '<string>', when: '<string>'}],
isAgentSpeakingFirst: true,
knowledgeBaseIds: ['<string>'],
scenarios: [
{
isEnabled: true,
reply: '<string>',
actionParameters: {},
toolId: '<string>',
when: '<string>'
}
],
secondaryLanguages: ['<string>'],
skills: {
answerQuestions: {
isEnabled: true,
transferConfig: {
agentExtension: '<string>',
agentId: 123,
groupExtension: '<string>',
groupId: 123
}
},
appointmentBooking: {
calendarId: '<string>',
durationMinutes: 240,
eventName: '<string>',
integrationId: '<string>',
isEnabled: true,
calendarEventDescription: '<string>',
serviceDescription: '<string>'
},
custom: [{isEnabled: true, name: '<string>', prompt: '<string>'}],
extractData: {
isEnabled: true,
properties: [{description: '<string>', name: 'callerName', type: 'STRING'}],
endpoint: '<string>'
},
takeMessage: {isEnabled: true, prompt: '<string>'},
transferToHuman: {
isEnabled: true,
rules: [
{
condition: '<string>',
agentExtension: '<string>',
agentId: 123,
groupExtension: '<string>',
groupId: 123
}
],
customProperties: [{description: '<string>', name: 'callerName', type: 'STRING'}],
includeProperties: [],
isConfirmationRequired: true
}
},
status: 'enabled',
tone: []
})
};
fetch('https://api.cloudtalk.io/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.cloudtalk.io/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([
'agentName' => 'Receptionist',
'defaultOutboundNumberId' => 73836,
'direction' => 'inbound',
'goalPrompt' => '<string>',
'language' => 'en',
'maxCallDurationMinutes' => 30,
'optimizeStreamingLatency' => 2,
'similarity' => 0.5,
'stability' => 0.5,
'temperature' => 0.5,
'voiceId' => 'cgSgspJ2msm6clMCkdW9',
'dialTimeoutSeconds' => 62,
'elevenLabsSettings' => [
'asrKeywords' => [
'<string>'
],
'backgroundSound' => [
'isCrossfadeLoopEnabled' => true,
'volume' => 0.5
],
'interruptionIgnoreTermLanguages' => [
'<string>'
],
'interruptionIgnoreTerms' => [
'<string>'
],
'isSpeculativeTurnEnabled' => true,
'isVadEnabled' => true
],
'failoverOutboundNumberId' => 73836,
'greeting' => '<string>',
'guardrails' => [
[
'isEnabled' => true,
'reply' => '<string>',
'when' => '<string>'
]
],
'isAgentSpeakingFirst' => true,
'knowledgeBaseIds' => [
'<string>'
],
'scenarios' => [
[
'isEnabled' => true,
'reply' => '<string>',
'actionParameters' => [
],
'toolId' => '<string>',
'when' => '<string>'
]
],
'secondaryLanguages' => [
'<string>'
],
'skills' => [
'answerQuestions' => [
'isEnabled' => true,
'transferConfig' => [
'agentExtension' => '<string>',
'agentId' => 123,
'groupExtension' => '<string>',
'groupId' => 123
]
],
'appointmentBooking' => [
'calendarId' => '<string>',
'durationMinutes' => 240,
'eventName' => '<string>',
'integrationId' => '<string>',
'isEnabled' => true,
'calendarEventDescription' => '<string>',
'serviceDescription' => '<string>'
],
'custom' => [
[
'isEnabled' => true,
'name' => '<string>',
'prompt' => '<string>'
]
],
'extractData' => [
'isEnabled' => true,
'properties' => [
[
'description' => '<string>',
'name' => 'callerName',
'type' => 'STRING'
]
],
'endpoint' => '<string>'
],
'takeMessage' => [
'isEnabled' => true,
'prompt' => '<string>'
],
'transferToHuman' => [
'isEnabled' => true,
'rules' => [
[
'condition' => '<string>',
'agentExtension' => '<string>',
'agentId' => 123,
'groupExtension' => '<string>',
'groupId' => 123
]
],
'customProperties' => [
[
'description' => '<string>',
'name' => 'callerName',
'type' => 'STRING'
]
],
'includeProperties' => [
],
'isConfirmationRequired' => true
]
],
'status' => 'enabled',
'tone' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.cloudtalk.io/v1/voice-agents"
payload := strings.NewReader("{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/voice-agents")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/voice-agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"attributes": {
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"createdAt": "2023-11-07T05:31:56Z",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": [
"<string>"
],
"backgroundSound": {
"preset": "city",
"isCrossfadeLoopEnabled": true,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": [
"<string>"
],
"interruptionIgnoreTerms": [
"<string>"
],
"isSpeculativeTurnEnabled": true,
"isVadEnabled": true,
"turnEagerness": "patient",
"turnModel": "turn_v2"
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": true,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": true,
"knowledgeBaseIds": [
"<string>"
],
"llmOverride": "openai - gpt-4o-mini",
"providerOverride": "elevenlabs",
"resolvedLlm": {
"model": "gpt-4o",
"provider": "openai"
},
"resolvedProvider": "<string>",
"scenarios": [
{
"isEnabled": true,
"reply": "<string>",
"action": "toolCall",
"actionParameters": {},
"toolId": "<string>",
"triggerType": "custom",
"when": "<string>"
}
],
"secondaryLanguages": [
"<string>"
],
"skills": {
"answerQuestions": {
"action": "admitUncertainty",
"isEnabled": true,
"transferConfig": {
"destination": "agent",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": true,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": true,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": true,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": true,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": true,
"rules": [
{
"condition": "<string>",
"destination": "agent",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [
"callerName"
],
"isConfirmationRequired": true
}
},
"status": "enabled",
"tone": [
"professional"
],
"updatedAt": "2023-11-07T05:31:56Z",
"verbosity": "concise"
},
"id": "<string>",
"type": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}VoiceAgent
Create a voice agent
Creates a voice agent from the attributes object.
POST
/
voice-agents
Create a voice agent
curl --request POST \
--url https://api.cloudtalk.io/v1/voice-agents \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": [
"<string>"
],
"backgroundSound": {
"isCrossfadeLoopEnabled": true,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": [
"<string>"
],
"interruptionIgnoreTerms": [
"<string>"
],
"isSpeculativeTurnEnabled": true,
"isVadEnabled": true
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": true,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": true,
"knowledgeBaseIds": [
"<string>"
],
"scenarios": [
{
"isEnabled": true,
"reply": "<string>",
"actionParameters": {},
"toolId": "<string>",
"when": "<string>"
}
],
"secondaryLanguages": [
"<string>"
],
"skills": {
"answerQuestions": {
"isEnabled": true,
"transferConfig": {
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": true,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": true,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": true,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": true,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": true,
"rules": [
{
"condition": "<string>",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [],
"isConfirmationRequired": true
}
},
"status": "enabled",
"tone": []
}
'import requests
url = "https://api.cloudtalk.io/v1/voice-agents"
payload = {
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": ["<string>"],
"backgroundSound": {
"isCrossfadeLoopEnabled": True,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": ["<string>"],
"interruptionIgnoreTerms": ["<string>"],
"isSpeculativeTurnEnabled": True,
"isVadEnabled": True
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": True,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": True,
"knowledgeBaseIds": ["<string>"],
"scenarios": [
{
"isEnabled": True,
"reply": "<string>",
"actionParameters": {},
"toolId": "<string>",
"when": "<string>"
}
],
"secondaryLanguages": ["<string>"],
"skills": {
"answerQuestions": {
"isEnabled": True,
"transferConfig": {
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": True,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": True,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": True,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": True,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": True,
"rules": [
{
"condition": "<string>",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [],
"isConfirmationRequired": True
}
},
"status": "enabled",
"tone": []
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Receptionist',
defaultOutboundNumberId: 73836,
direction: 'inbound',
goalPrompt: '<string>',
language: 'en',
maxCallDurationMinutes: 30,
optimizeStreamingLatency: 2,
similarity: 0.5,
stability: 0.5,
temperature: 0.5,
voiceId: 'cgSgspJ2msm6clMCkdW9',
dialTimeoutSeconds: 62,
elevenLabsSettings: {
asrKeywords: ['<string>'],
backgroundSound: {isCrossfadeLoopEnabled: true, volume: 0.5},
interruptionIgnoreTermLanguages: ['<string>'],
interruptionIgnoreTerms: ['<string>'],
isSpeculativeTurnEnabled: true,
isVadEnabled: true
},
failoverOutboundNumberId: 73836,
greeting: '<string>',
guardrails: [{isEnabled: true, reply: '<string>', when: '<string>'}],
isAgentSpeakingFirst: true,
knowledgeBaseIds: ['<string>'],
scenarios: [
{
isEnabled: true,
reply: '<string>',
actionParameters: {},
toolId: '<string>',
when: '<string>'
}
],
secondaryLanguages: ['<string>'],
skills: {
answerQuestions: {
isEnabled: true,
transferConfig: {
agentExtension: '<string>',
agentId: 123,
groupExtension: '<string>',
groupId: 123
}
},
appointmentBooking: {
calendarId: '<string>',
durationMinutes: 240,
eventName: '<string>',
integrationId: '<string>',
isEnabled: true,
calendarEventDescription: '<string>',
serviceDescription: '<string>'
},
custom: [{isEnabled: true, name: '<string>', prompt: '<string>'}],
extractData: {
isEnabled: true,
properties: [{description: '<string>', name: 'callerName', type: 'STRING'}],
endpoint: '<string>'
},
takeMessage: {isEnabled: true, prompt: '<string>'},
transferToHuman: {
isEnabled: true,
rules: [
{
condition: '<string>',
agentExtension: '<string>',
agentId: 123,
groupExtension: '<string>',
groupId: 123
}
],
customProperties: [{description: '<string>', name: 'callerName', type: 'STRING'}],
includeProperties: [],
isConfirmationRequired: true
}
},
status: 'enabled',
tone: []
})
};
fetch('https://api.cloudtalk.io/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.cloudtalk.io/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([
'agentName' => 'Receptionist',
'defaultOutboundNumberId' => 73836,
'direction' => 'inbound',
'goalPrompt' => '<string>',
'language' => 'en',
'maxCallDurationMinutes' => 30,
'optimizeStreamingLatency' => 2,
'similarity' => 0.5,
'stability' => 0.5,
'temperature' => 0.5,
'voiceId' => 'cgSgspJ2msm6clMCkdW9',
'dialTimeoutSeconds' => 62,
'elevenLabsSettings' => [
'asrKeywords' => [
'<string>'
],
'backgroundSound' => [
'isCrossfadeLoopEnabled' => true,
'volume' => 0.5
],
'interruptionIgnoreTermLanguages' => [
'<string>'
],
'interruptionIgnoreTerms' => [
'<string>'
],
'isSpeculativeTurnEnabled' => true,
'isVadEnabled' => true
],
'failoverOutboundNumberId' => 73836,
'greeting' => '<string>',
'guardrails' => [
[
'isEnabled' => true,
'reply' => '<string>',
'when' => '<string>'
]
],
'isAgentSpeakingFirst' => true,
'knowledgeBaseIds' => [
'<string>'
],
'scenarios' => [
[
'isEnabled' => true,
'reply' => '<string>',
'actionParameters' => [
],
'toolId' => '<string>',
'when' => '<string>'
]
],
'secondaryLanguages' => [
'<string>'
],
'skills' => [
'answerQuestions' => [
'isEnabled' => true,
'transferConfig' => [
'agentExtension' => '<string>',
'agentId' => 123,
'groupExtension' => '<string>',
'groupId' => 123
]
],
'appointmentBooking' => [
'calendarId' => '<string>',
'durationMinutes' => 240,
'eventName' => '<string>',
'integrationId' => '<string>',
'isEnabled' => true,
'calendarEventDescription' => '<string>',
'serviceDescription' => '<string>'
],
'custom' => [
[
'isEnabled' => true,
'name' => '<string>',
'prompt' => '<string>'
]
],
'extractData' => [
'isEnabled' => true,
'properties' => [
[
'description' => '<string>',
'name' => 'callerName',
'type' => 'STRING'
]
],
'endpoint' => '<string>'
],
'takeMessage' => [
'isEnabled' => true,
'prompt' => '<string>'
],
'transferToHuman' => [
'isEnabled' => true,
'rules' => [
[
'condition' => '<string>',
'agentExtension' => '<string>',
'agentId' => 123,
'groupExtension' => '<string>',
'groupId' => 123
]
],
'customProperties' => [
[
'description' => '<string>',
'name' => 'callerName',
'type' => 'STRING'
]
],
'includeProperties' => [
],
'isConfirmationRequired' => true
]
],
'status' => 'enabled',
'tone' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.cloudtalk.io/v1/voice-agents"
payload := strings.NewReader("{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/voice-agents")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/voice-agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Receptionist\",\n \"defaultOutboundNumberId\": 73836,\n \"direction\": \"inbound\",\n \"goalPrompt\": \"<string>\",\n \"language\": \"en\",\n \"maxCallDurationMinutes\": 30,\n \"optimizeStreamingLatency\": 2,\n \"similarity\": 0.5,\n \"stability\": 0.5,\n \"temperature\": 0.5,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"dialTimeoutSeconds\": 62,\n \"elevenLabsSettings\": {\n \"asrKeywords\": [\n \"<string>\"\n ],\n \"backgroundSound\": {\n \"isCrossfadeLoopEnabled\": true,\n \"volume\": 0.5\n },\n \"interruptionIgnoreTermLanguages\": [\n \"<string>\"\n ],\n \"interruptionIgnoreTerms\": [\n \"<string>\"\n ],\n \"isSpeculativeTurnEnabled\": true,\n \"isVadEnabled\": true\n },\n \"failoverOutboundNumberId\": 73836,\n \"greeting\": \"<string>\",\n \"guardrails\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"isAgentSpeakingFirst\": true,\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"scenarios\": [\n {\n \"isEnabled\": true,\n \"reply\": \"<string>\",\n \"actionParameters\": {},\n \"toolId\": \"<string>\",\n \"when\": \"<string>\"\n }\n ],\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"skills\": {\n \"answerQuestions\": {\n \"isEnabled\": true,\n \"transferConfig\": {\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n },\n \"appointmentBooking\": {\n \"calendarId\": \"<string>\",\n \"durationMinutes\": 240,\n \"eventName\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"isEnabled\": true,\n \"calendarEventDescription\": \"<string>\",\n \"serviceDescription\": \"<string>\"\n },\n \"custom\": [\n {\n \"isEnabled\": true,\n \"name\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"extractData\": {\n \"isEnabled\": true,\n \"properties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"endpoint\": \"<string>\"\n },\n \"takeMessage\": {\n \"isEnabled\": true,\n \"prompt\": \"<string>\"\n },\n \"transferToHuman\": {\n \"isEnabled\": true,\n \"rules\": [\n {\n \"condition\": \"<string>\",\n \"agentExtension\": \"<string>\",\n \"agentId\": 123,\n \"groupExtension\": \"<string>\",\n \"groupId\": 123\n }\n ],\n \"customProperties\": [\n {\n \"description\": \"<string>\",\n \"name\": \"callerName\",\n \"type\": \"STRING\"\n }\n ],\n \"includeProperties\": [],\n \"isConfirmationRequired\": true\n }\n },\n \"status\": \"enabled\",\n \"tone\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"attributes": {
"agentName": "Receptionist",
"defaultOutboundNumberId": 73836,
"direction": "inbound",
"goalPrompt": "<string>",
"language": "en",
"maxCallDurationMinutes": 30,
"optimizeStreamingLatency": 2,
"similarity": 0.5,
"stability": 0.5,
"temperature": 0.5,
"voiceId": "cgSgspJ2msm6clMCkdW9",
"createdAt": "2023-11-07T05:31:56Z",
"dialTimeoutSeconds": 62,
"elevenLabsSettings": {
"asrKeywords": [
"<string>"
],
"backgroundSound": {
"preset": "city",
"isCrossfadeLoopEnabled": true,
"volume": 0.5
},
"interruptionIgnoreTermLanguages": [
"<string>"
],
"interruptionIgnoreTerms": [
"<string>"
],
"isSpeculativeTurnEnabled": true,
"isVadEnabled": true,
"turnEagerness": "patient",
"turnModel": "turn_v2"
},
"failoverOutboundNumberId": 73836,
"greeting": "<string>",
"guardrails": [
{
"isEnabled": true,
"reply": "<string>",
"when": "<string>"
}
],
"isAgentSpeakingFirst": true,
"knowledgeBaseIds": [
"<string>"
],
"llmOverride": "openai - gpt-4o-mini",
"providerOverride": "elevenlabs",
"resolvedLlm": {
"model": "gpt-4o",
"provider": "openai"
},
"resolvedProvider": "<string>",
"scenarios": [
{
"isEnabled": true,
"reply": "<string>",
"action": "toolCall",
"actionParameters": {},
"toolId": "<string>",
"triggerType": "custom",
"when": "<string>"
}
],
"secondaryLanguages": [
"<string>"
],
"skills": {
"answerQuestions": {
"action": "admitUncertainty",
"isEnabled": true,
"transferConfig": {
"destination": "agent",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
},
"appointmentBooking": {
"calendarId": "<string>",
"durationMinutes": 240,
"eventName": "<string>",
"integrationId": "<string>",
"isEnabled": true,
"calendarEventDescription": "<string>",
"serviceDescription": "<string>"
},
"custom": [
{
"isEnabled": true,
"name": "<string>",
"prompt": "<string>"
}
],
"extractData": {
"isEnabled": true,
"properties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"endpoint": "<string>"
},
"takeMessage": {
"isEnabled": true,
"prompt": "<string>"
},
"transferToHuman": {
"isEnabled": true,
"rules": [
{
"condition": "<string>",
"destination": "agent",
"agentExtension": "<string>",
"agentId": 123,
"groupExtension": "<string>",
"groupId": 123
}
],
"customProperties": [
{
"description": "<string>",
"name": "callerName",
"type": "STRING"
}
],
"includeProperties": [
"callerName"
],
"isConfirmationRequired": true
}
},
"status": "enabled",
"tone": [
"professional"
],
"updatedAt": "2023-11-07T05:31:56Z",
"verbosity": "concise"
},
"id": "<string>",
"type": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"target": "<string>"
}
],
"target": "<string>"
},
"requestId": "<string>"
}Authorizations
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Body
application/json
Name of the agent
Maximum string length:
255Example:
"Receptionist"
Outbound caller id; null selects Automatic Outbound and then requires failoverOutboundNumberId
Example:
73836
Call direction the agent serves
Available options:
inbound, outbound Example:
"inbound"
What the agent is supposed to achieve
Maximum string length:
20000Primary language code
Maximum string length:
16Example:
"en"
Hard cap on one call
Required range:
1 <= x <= 180Example:
30
Latency optimisation level
Required range:
0 <= x <= 4Voice similarity boost
Required range:
0 <= x <= 1Voice stability
Required range:
0 <= x <= 1Creativity of the agent's replies
Required range:
0 <= x <= 1Voice the agent speaks with
Maximum string length:
64Example:
"cgSgspJ2msm6clMCkdW9"
Ring timeout; null uses the provider default
Required range:
5 <= x <= 120Provider turn-taking and audio tuning
Show child attributes
Show child attributes
Number used when the default one cannot be used
Example:
73836
Opening line; required for inbound agents
Maximum string length:
2000Topics the agent must avoid
Maximum array length:
50Show child attributes
Show child attributes
Whether the agent speaks first; omitted means true for inbound and false for outbound
Knowledge bases the agent answers from
Maximum array length:
100Pin the model by its canonical id; null lets the server choose
Available options:
openai - gpt-4o-mini, openai - gpt-4o, openai - gpt-4.1, openai - gpt-4.1-mini, openai - gpt-4.1-nano, openai - gpt-5, openai - gpt-5-mini, openai - gpt-5-nano, openai - gpt-5.1, openai - gpt-5.2, openai - gpt-5.4, openai - gpt-5.4-mini, openai - gpt-5.4-nano, openai - gpt-5.5, anthropic - claude-haiku-4-5, anthropic - claude-sonnet-4-5, anthropic - claude-sonnet-4-6, google - gemini-2.5-flash, google - gemini-2.5-flash-lite, google - gemini-3-flash-preview, google - gemini-3.1-flash-lite, google - gemini-3.5-flash, google - gemini-3.6-flash, qwen - qwen36-35b-a3b, qwen - qwen35-397b-a17b Maximum string length:
100Pin the speech provider; null lets the server choose
Available options:
elevenlabs, deepgram Situational instructions
Maximum array length:
50Show child attributes
Show child attributes
Additional languages; codes the resolved provider cannot serve are dropped
Maximum array length:
20Capabilities the agent may use
Show child attributes
Show child attributes
Whether the agent may run; omitted on write means enabled
Available options:
enabled, disabled Example:
"enabled"
Tone presets the agent blends
Maximum array length:
6Available options:
professional, friendly, casual, calm, empathetic, direct How much the agent elaborates; omitted means standard
Available options:
concise, standard, thorough