Skip to main content
POST
Create a new agent
Required scope: agents.edit

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json
name
string
required
Required string length: 1 - 100
voice
string
required
Minimum string length: 1
prompt
string
Maximum string length: 128000
greeting
string
Maximum string length: 2000
preCallVariables
string[]
Maximum array length: 100
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
extractionConfig
object
agentType
enum<string>
Available options:
OUTBOUND,
INBOUND
enableRecording
boolean
endCallEnabled
boolean
endCallMessage
string
Maximum string length: 500
endCallTriggers
enum<string>[]
Maximum array length: 4
Available options:
CALLER_GOODBYE,
GOAL_COMPLETED,
IDLE,
REMOVE_FROM_LIST
maxCallDurationSecs
integer
Required range: 60 <= x <= 3600
backgroundAudioId
string | null
backgroundAudioVolume
number | null
Required range: 0 <= x <= 1
voicemailDetectionEnabled
boolean
voicemailMessage
string | null
Maximum string length: 500
screenerHandlingEnabled
boolean
transferEnabled
boolean
transferNumber
string
Maximum string length: 32
Pattern: ^\+\d{8,15}$
transferMessage
string
Maximum string length: 500
transferTriggers
enum<string>[]
Available options:
CALLER_ASKS_HUMAN,
FRUSTRATED,
ASKS_MANAGER,
UNKNOWN_QUESTION,
BILLING
studioConfig
object
abilities
object

Response

Created

id
string
required
name
string
required
prompt
string
required
greeting
string | null
required
voice
string
required
status
string
required
preCallVariables
string[] | null
required
variables
string[]
required
systemVariables
string[]
required
extractionConfig
object | null
required
agentType
string
required
enableRecording
boolean
required
endCallEnabled
boolean
required
endCallMessage
string | null
required
endCallTriggers
string[] | null
required
maxCallDurationSecs
number | null
required
backgroundAudioId
string | null
required
backgroundAudioVolume
number | null
required
voicemailDetectionEnabled
boolean
required
voicemailMessage
string | null
required
screenerHandlingEnabled
boolean
required
transferEnabled
boolean
required
transferNumber
string | null
required
transferMessage
string | null
required
transferTriggers
string[] | null
required
language
string
required
studioConfig
object | null
required
abilities
object | null
required
promptEditedManually
boolean
required
createdAt
string
required
updatedAt
string
required
warnings
object[]