Skip to main content
POST
Create a new agent

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
description
string | null
required
voicemailMessage
string | null
required
overrideSTTConfig
object | null
required
templateId
string
agentType
enum<string>
default:CALL
Available options:
CALL,
TEXT
useKnowledgeBase
boolean
default:true
prompt
object | null
promptPersonalityId
string | null
llmConfigId
string | null
languageId
string<uuid> | null
sttConfigId
string | null
ttsConfigId
string | null
voiceId
string | null
enableBackgroundAudio
boolean
default:false
backgroundAudio
number
default:50
Required range: 0 < x < 100
voiceVolume
integer
default:100
Required range: 10 <= x <= 120
voiceSpeed
number
default:1
Required range: 0.8 <= x <= 1.2
agentDelayBeforeFirstMessage
integer
default:500
Required range: 0 <= x <= 2500
initialSilenceTimeout
integer
default:30000
Required range: 0 <= x <= 60000
finalSilenceTimeout
integer
default:10000
Required range: 0 <= x <= 60000
transferImmediatelyOnInbound
boolean
default:false
maxCallDuration
integer
default:900
Required range: 300 <= x <= 6000
voicemailDetectionMode
enum<string>
default:ASYNC
Available options:
ASYNC,
SYNC
minInterruptionWords
integer
default:1
Required range: x >= 0
minInterruptionDuration
number
default:1
Required range: x >= 0
minEndpointingDelay
number
default:0.5
Required range: x >= 0
maxEndpointingDelay
number
default:3
Required range: x >= 0
vadActivationThreshold
number
default:0.5
Required range: 0.1 <= x <= 0.9
sms
object
webChatAggregationWindowSeconds
integer | null
Required range: 1 <= x <= 115
emailDomainId
string | null
emailFromLocalPart
string | null
emailFromName
string | null
emailMaxTokens
integer | null
Required range: 100 <= x <= 10000
emailTemperature
number | null
Required range: 0 <= x <= 2
emailInactivityTimeoutHours
integer | null
Required range: x >= 1
warmTransferMessageMode
enum<string> | null
Available options:
STATIC,
PROMPT
warmTransferBriefingTemplate
string | null
warmTransferInteractive
boolean
warmTransferInstructions
string | null

Response

Agent created successfully

agent
object
required