Skip to main content
GET
Get an agent

Authorizations

X-API-Key
string
header
required

Path Parameters

account_id
string
required
agent_id
string<uuid4>
required

Response

OK

Response returned after agent operations (create, get, update)

id
string<uuid4>
required

Unique identifier for the agent. Use this ID to reference the agent in API calls for updates, deletion, or starting conversations.

account_id
string<uuid4>
required

Unique identifier for the account that owns this agent.

name
string
required

The display name of the agent as configured. This is for your reference and internal organization.

initial_message
InitialMessageSchema · object
required

Configuration for the agent's initial message when starting a conversation.

ambient_sound
AmbientSoundSchema · object
required

Configuration for ambient background sounds during the conversation.

inactivity_settings
InactivitySettings · object
required

Configuration for handling user inactivity and silence during conversations.

response_timing
ResponseTimingSchema · object
required

Configuration for agent response timing and conversation flow control.

allow_auto_hangup
boolean
required

Whether the AI may automatically end the call when the conversation has concluded.

allow_caller_recording_opt_out
boolean
required

Whether callers may request that recording stop and captured audio be deleted.

max_duration_seconds
integer | null

The maximum conversation duration configured for this agent in seconds. Maximum allowed is 7200 seconds (2 hours).

note
string | null

Internal notes about the agent for your team's reference.

tags
string[] | null

List of tags assigned to this agent for categorization and filtering.

interrupt_settings
InterruptSettings · object | null

Configuration for how the agent handles user interruptions during conversation.

model
Model · object | null

Language model configuration for the agent.

transcriber
Transcriber · object | null

Speech-to-text configuration for the agent.

voice
Voice · object | null

Text-to-speech configuration for the agent.

metadata
Metadata · object | null

Custom metadata associated with the agent.

capture_settings
CaptureSettingsSchema · object | null

Capture settings configuration for recording and artifact settings.

volume
VolumeSchema · object | null

Volume settings for different call types and voice adjustment control.

denoising
DenoisingSchema · object | null

Denoising/noise cancellation settings for enhanced audio quality powered by Krisp.

created
string<date-time> | null

Date-time of when the agent was created (ISO 8601 on output).

modified
string<date-time> | null

Date-time of when the agent was last updated (ISO 8601 on output).