Skip to main content
GET
Get an agent by id
Required scope: agents.view

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id
string
required

Response

OK

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