Skip to main content
GET
Get AI Agent

Path Parameters

agent_id
string
required

Response

Successful Response

ai_agent_id
string
required

Unique identifier for the AI agent

agent_name
string
required

Name of the AI agent

llm
SimplePiaLLMResponse · object
required

Language model configuration for the AI agent

stt
DeepgramSTTResponse · object
required

Speech-to-text configuration for the AI agent

tts
ElevenLabsTTSResponse · object
required

Text-to-speech configuration for the AI agent

created_by_user_id
string
required

ID of the user who created this AI agent

language_code
string
default:en-US

Language code for the AI agent in BCP-47 format

knowledge_base_id
string | null

ID of the associated knowledge base, if any

enable_user_interruptions
boolean
default:true

Whether to allow users to interrupt the AI agent while speaking

minimum_speech_duration_for_interruptions
number
default:0.5

Minimum duration of speech in seconds before interruptions are allowed

Required range: 0 <= x <= 15
minimum_words_before_interruption
integer
default:0

Minimum number of words that must be spoken before interruption is allowed

Required range: 0 <= x <= 5
wait_time_before_detecting_end_of_speech
number
default:0.5

Time in seconds to wait before considering speech has ended

Required range: 0 <= x <= 15
ambient_sound
enum<string>
default:none

Type of ambient background sound to use during calls

Available options:
office,
cafe,
restaurant,
park,
street,
home,
library,
airport,
train_station,
beach,
none
ambient_sound_volume
number
default:1

Volume level for ambient sound, from 0 (muted) to 2 (loud)

Required range: 0 <= x <= 2
webhook_url
string | null

URL to send webhook notifications about call events

end_call_after_silence_seconds
number
default:10

Number of seconds of silence before automatically ending the call

Required range: 10 <= x <= 30
max_call_duration_seconds
number
default:1800

Maximum duration of a call in seconds

Required range: 30 <= x <= 3600
welcome_message
string | null

Custom welcome message to play at the start of calls

voicemail_detection_timeout_seconds
number
default:90

Time in seconds to wait for voicemail detection

Required range: x >= 0
dynamic_data_config
DynamicDataConfigItemResponse · object[] | null

Configuration for dynamic data sources that can be used during calls

post_call_analysis
(StringPostCallAnalysisItemResponse · object | EnumPostCallAnalysisItemResponse · object | BooleanPostCallAnalysisItemResponse · object | NumberPostCallAnalysisItemResponse · object)[] | null

Configuration for analysis items to be processed after calls