Sign in

v1

latestOpenAPI 3.1.02026-07-22152755.8 KB
test_framework

Retrieve an AI voice agent

Retrieve an AI voice agent, including its configured connections.

Configured connection → run endpoint (call this before running scenarios; a run endpoint only works if its connection is configured on the agent):

  • telephony.phone_number → scenarios-run-voice
  • telephony.sip_uri → scenarios-run-sip
  • telephony.websocket_url → scenarios-run-chirp (raw-PCM voice websocket)
  • provider.type vapi / retell / livekit / pipecat / agora (WebRTC) → scenarios-run-vapi-webrtc / -retell-webrtc / -livekit-v2 / -pipecat-v2 / -agora
  • provider.type elevenlabs → scenarios-run-elevenlabs
  • provider.chat_agent_details (chat/SMS/WhatsApp) → scenarios-run-text
get/test_framework/v2/aiagents/{id}/

Path parameters

idinteger required

A unique integer value identifying this ai agent.

Response

idinteger

Agent ID. Example: 2142

namestring

Agent name. Optional when configure_from_provider is set — it's fetched from the provider.

descriptionstring

A detailed description of what this agent does and how it should interact Example: