Get agent

1 from elevenlabs import ElevenLabs 2 3 client = ElevenLabs( 4 api_key="YOUR_API_KEY", 5 ) 6 client.conversational_ai.get_agent( 7 agent_id="21m00Tcm4TlvDq8ikWAM", 8 )

1 { 2 "agent_id": "agent_id", 3 "name": "name", 4 "conversation_config": { 5 "asr": { 6 "quality": "high", 7 "provider": "elevenlabs", 8 "user_input_audio_format": "pcm_8000", 9 "keywords": [ 10 "keywords" 11 ] 12 }, 13 "turn": { 14 "turn_timeout": 1.1, 15 "mode": "silence" 16 }, 17 "tts": { 18 "model_id": "eleven_turbo_v2", 19 "voice_id": "voice_id", 20 "agent_output_audio_format": "pcm_8000", 21 "optimize_streaming_latency": 1, 22 "stability": 1.1, 23 "speed": 1.1, 24 "similarity_boost": 1.1, 25 "pronunciation_dictionary_locators": [ 26 { 27 "pronunciation_dictionary_id": "pronunciation_dictionary_id", 28 "version_id": "version_id" 29 } 30 ] 31 }, 32 "conversation": { 33 "max_duration_seconds": 1, 34 "client_events": [ 35 "conversation_initiation_metadata" 36 ] 37 }, 38 "language_presets": { 39 "key": { 40 "overrides": {} 41 } 42 }, 43 "agent": { 44 "first_message": "first_message", 45 "language": "language" 46 } 47 }, 48 "metadata": { 49 "created_at_unix_secs": 1 50 }, 51 "platform_settings": { 52 "auth": { 53 "enable_auth": true, 54 "allowlist": [ 55 { 56 "hostname": "hostname" 57 } 58 ], 59 "shareable_token": "shareable_token" 60 }, 61 "evaluation": { 62 "criteria": [ 63 { 64 "id": "id", 65 "conversation_goal_prompt": "conversation_goal_prompt" 66 } 67 ] 68 }, 69 "widget": { 70 "variant": "compact", 71 "expandable": "never", 72 "avatar": { 73 "type": "orb" 74 }, 75 "feedback_mode": "none", 76 "bg_color": "bg_color", 77 "text_color": "text_color", 78 "btn_color": "btn_color", 79 "btn_text_color": "btn_text_color", 80 "border_color": "border_color", 81 "focus_color": "focus_color", 82 "border_radius": 1, 83 "btn_radius": 1, 84 "action_text": "action_text", 85 "start_call_text": "start_call_text", 86 "end_call_text": "end_call_text", 87 "expand_text": "expand_text", 88 "listening_text": "listening_text", 89 "speaking_text": "speaking_text", 90 "shareable_page_text": "shareable_page_text", 91 "shareable_page_show_terms": true, 92 "terms_text": "terms_text", 93 "terms_html": "terms_html", 94 "terms_key": "terms_key", 95 "show_avatar_when_collapsed": true, 96 "disable_banner": true, 97 "mic_muting_enabled": true, 98 "language_selector": true, 99 "custom_avatar_path": "custom_avatar_path" 100 }, 101 "data_collection": { 102 "key": { 103 "type": "boolean" 104 } 105 }, 106 "overrides": { 107 "custom_llm_extra_body": true, 108 "enable_conversation_initiation_client_data_from_webhook": true 109 }, 110 "call_limits": { 111 "agent_concurrency_limit": 1, 112 "daily_limit": 1 113 }, 114 "ban": { 115 "at_unix": 1, 116 "reason_type": "safety", 117 "reason": "reason" 118 }, 119 "privacy": { 120 "record_voice": true, 121 "retention_days": 1, 122 "delete_transcript_and_pii": true, 123 "delete_audio": true, 124 "apply_to_existing_conversations": true 125 }, 126 "workspace_overrides": { 127 "conversation_initiation_client_data_webhook": { 128 "url": "url", 129 "request_headers": { 130 "key": "value" 131 } 132 } 133 }, 134 "safety": { 135 "is_blocked_ivc": true, 136 "is_blocked_non_ivc": true 137 } 138 }, 139 "phone_numbers": [ 140 { 141 "phone_number": "phone_number", 142 "provider": "twilio", 143 "label": "label", 144 "phone_number_id": "phone_number_id", 145 "assigned_agent": { 146 "agent_id": "agent_id", 147 "agent_name": "agent_name" 148 } 149 } 150 ] 151 }

Retrieve config for an agent

Path parameters

agent_idstringRequired

The id of an agent. This is returned on agent creation.

Response

Successful Response

agent_idstring

namestring

conversation_configobject

metadataobject

platform_settingsobjectOptional

phone_numberslist of objectsOptional

Path parameters

Headers

Response

Errors