Skip to main content
GET
Get Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
user_id
string<uuid>
required
prompt
Prompt · object
required
actions
(TransferCallAction · object | EndConversationAction · object | DTMFAction · object | AddToConferenceAction · object | SetHoldAction · object | ExternalAction · object)[]
required
voice
AzureVoice · object
required
name
string | null
language
enum<string>
default:en
Available options:
en,
es,
de,
hi,
pt,
fr,
nl,
id,
it,
ja,
ko
initial_message
string | null
webhook
Webhook · object | null
vector_database
PineconeVectorDatabase · object | null
interrupt_sensitivity
enum<string>
default:low
Available options:
low,
high
context_endpoint
string | null
noise_suppression
boolean
default:false
endpointing_sensitivity
enum<string>
default:auto
Available options:
auto,
relaxed,
sensitive
ivr_navigation_mode
enum<string>
default:off
Available options:
default,
off
conversation_speed
number
default:1
initial_message_delay
number
default:0
openai_model_name_override
string | null
ask_if_human_present_on_idle
boolean
default:false
openai_account_connection
OpenAIAccountConnection · object | null
run_do_not_call_detection
boolean
default:false
llm_fallback
InternalLLMFallback · object | null
deepgram_keywords
Deepgram Keywords · object | null
idle_time_seconds
integer | null
llm_temperature
number
default:0