Sign in

v3

OpenAPI 3.1.02026-07-31350397683.8 KB
Agents

Get Agent

Get an agent by ID.

get/v1/agents/{agent_id}

Path parameters

agent_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

bluejay_as_code_idstring uuid nullable
namestring required
agent_descriptionstring required
organization_idstring required
goalsstring[] nullable
mode'VOICE' | 'TEXT' required

Enum representing the mode of agent

type'INBOUND' | 'OUTBOUND'

Enum representing the type of agent

connection_type'SMS' | 'HTTP_WEBHOOK' | 'PHONE' | 'SIP' | 'WEBSOCKET' | 'LIVEKIT' | 'PIPECAT' | 'ELEVEN_LABS' | 'RETELL' | 'VAPI' | 'KORE' | 'AMELIA_CHAT' | 'AMELIA_VOICE' | 'GOOGLE_CES_CHAT' | 'GOOGLE_CES_VOICE' | 'GOOGLE_DFCX_VOICE' | 'GOOGLE_DFCX_CHAT'

Enum representing the connection type of the agent

phone_numberstring nullable
follow_up_sms_sender_numbersstring[] nullable
websocket_urlstring nullable
redact_piiboolean nullable
folder_idstring uuid nullable
created_atstring date-time nullable
updated_atstring date-time nullable
updated_bystring uuid nullable
created_bystring uuid nullable
keytermsstring[] nullable
voice_providerstring nullable
provider_idstring nullable
websocket_usernamestring nullable
websocket_passwordstring nullable
external_agent_idstring nullable
sip_uristring nullable
custom_sip_headersobject nullable
sip_usernamestring nullable
sip_passwordstring nullable
simulation_notificationsobject
livekit_agent_namestring nullable
livekit_metadataobject nullable
livekit_customer_tool_topicstring nullable
livekit_token_webhook_urlstring nullable
pipecat_agent_namestring nullable
pipecat_agent_configurationobject nullable
pipecat_room_propertiesobject nullable
http_webhookstring nullable
http_webhook_keystring nullable
dynamic_sip_webhook_urlstring nullable
outbound_trigger_webhook_urlstring nullable
outbound_trigger_payload_templateobject nullable
eleven_labs_agent_idstring nullable
retell_agent_idstring nullable
vapi_assistant_idstring nullable
ces_app_idstring nullable
ces_deployment_idstring nullable
dfcx_project_idstring nullable
dfcx_locationstring nullable
dfcx_agent_idstring nullable
amelia_base_urlstring nullable
amelia_domain_codestring nullable
amelia_flow_namestring nullable
amelia_agent_namestring nullable
kore_hoststring nullable
kore_bot_idstring nullable
kore_client_idstring nullable
kore_client_secretstring nullable
kore_inbound_tokenstring nullable
enable_outbound_call_auto_startboolean nullable
simulations_disabledboolean nullable
workflowobject nullable
provider'CUSTOM' | 'ELEVENLABS' | 'VAPI' | 'RETELL' | 'GOOGLE_CES_VOICE' | 'GOOGLE_CES_CHAT' | 'GOOGLE_DFCX_VOICE' | 'GOOGLE_DFCX_CHAT' | 'AMELIA'

Source platform the agent's definition (system prompt, workflow) comes from.

Distinct from voice_provider (TTS/STT vendor) and provider_id (handle on that vendor) — this identifies where the agent's behavior (prompt, multi-agent graph) is authored.

red_team_profileobject nullable