Get agent

GET

/v1/convai/agents/:agent_id

GET

/v1/convai/agents/:agent_id

curl -G https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz \
     -d branch_id=branch_id \
     -d version_id=version_id

{
  "agent_id": "agent_7101k5zvyjhmfg983brhmhkd98n6",
  "name": "My Agent",
  "conversation_config": {
    "asr": {
      "quality": "high",
      "provider": "scribe_realtime",
      "user_input_audio_format": "pcm_16000",
      "keywords": [
        "hello",
        "world"
      ]
    },
    "turn": {
      "turn_timeout": 7,
      "initial_wait_time": 1.1,
      "silence_end_call_timeout": -1,
      "turn_eagerness": "normal",
      "spelling_patience": "auto",
      "speculative_turn": false,
      "retranscribe_on_turn_timeout": false,
      "turn_model": "turn_v3",
      "interruption_ignore_terms": [
        "interruption_ignore_terms"
      ],
      "interruption_ignore_term_languages": [
        "interruption_ignore_term_languages"
      ],
      "merge_with_default_ignore_terms": false,
      "transcribe_on_disabled_interruptions": false,
      "soft_timeout_config": {
        "timeout_seconds": -1,
        "message": "Hhmmmm...yeah."
      }
    },
    "tts": {
      "model_id": "eleven_turbo_v2",
      "voice_id": "cjVigY5qzO86Huf0OWal",
      "supported_voices": [
        {
          "label": "label",
          "voice_id": "voice_id"
        }
      ],
      "expressive_mode": true,
      "suggested_audio_tags": [
        {
          "tag": "tag"
        }
      ],
      "agent_output_audio_format": "pcm_16000",
      "optimize_streaming_latency": 3,
      "stability": 0.5,
      "speed": 1,
      "similarity_boost": 0.8,
      "text_normalisation_type": "system_prompt",
      "pronunciation_dictionary_locators": [
        {
          "pronunciation_dictionary_id": "pronunciation_dictionary_id",
          "version_id": null
        }
      ],
      "enable_phoneme_tags": true,
      "audio_effects": {
        "distance": 1.1,
        "send_level": 1.1,
        "filter_preset_id": null,
        "environment_id": null,
        "background_noise_id": null,
        "seed": null
      }
    },
    "conversation": {
      "text_only": true,
      "max_duration_seconds": 600,
      "client_events": [
        "audio",
        "interruption"
      ],
      "monitoring_enabled": true,
      "monitoring_events": [
        "conversation_initiation_metadata"
      ],
      "source_attribution": true
    },
    "language_presets": {
      "key": {
        "overrides": {
          "asr": {
            "keywords": [
              "hello",
              "world"
            ]
          },
          "turn": {
            "soft_timeout_config": {
              "message": "Hhmmmm...yeah."
            }
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8,
            "pronunciation_dictionary_locators": [
              {
                "pronunciation_dictionary_id": "pronunciation_dictionary_id",
                "version_id": null
              }
            ]
          },
          "conversation": {
            "max_duration_seconds": 600
          },
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "prompt": {
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "llm": "gemini-2.0-flash-001",
              "tool_ids": [
                "tool_ids"
              ],
              "knowledge_base": [
                {
                  "type": "file",
                  "name": "My Knowledge Base",
                  "id": "123",
                  "usage_mode": "auto"
                }
              ]
            }
          }
        }
      }
    },
    "agent": {
      "first_message": "Hello, how can I help you today?",
      "language": "en",
      "hinglish_mode": true,
      "disable_first_message_interruptions": false,
      "max_conversation_duration_message": "max_conversation_duration_message",
      "prompt": {
        "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
        "llm": "gemini-2.0-flash-001",
        "temperature": 0,
        "max_tokens": -1,
        "tool_ids": [
          "tool_ids"
        ],
        "built_in_tools": {
          "transfer_to_agent": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "end_call": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "language_detection": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "transfer_to_number": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "skip_turn": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "play_keypad_touch_tone": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          },
          "voicemail_detection": {
            "name": "end_call",
            "params": {
              "system_tool_type": "end_call"
            },
            "type": "system",
            "description": "",
            "assignments": [
              {
                "dynamic_variable": "user_name",
                "value_path": "user.name",
                "source": "response",
                "sanitize": false,
                "preserve_native_type": false
              }
            ]
          }
        },
        "knowledge_base": [
          {
            "type": "file",
            "name": "My Knowledge Base",
            "id": "123",
            "usage_mode": "auto"
          }
        ],
        "rag": {
          "max_vector_distance": 0.5,
          "max_retrieved_rag_chunks_count": 5
        }
      }
    }
  },
  "metadata": {
    "created_at_unix_secs": 1,
    "updated_at_unix_secs": 1
  },
  "platform_settings": {
    "evaluation": {
      "criteria": [
        {
          "id": "criterion_binary_001",
          "name": "Issue resolved",
          "conversation_goal_prompt": "Determine whether the agent fully resolved the user's issue.",
          "use_knowledge_base": false,
          "scope": "conversation",
          "scoring_mode": "binary",
          "max_score": 100
        }
      ]
    },
    "widget": {
      "variant": "tiny",
      "placement": "top-left",
      "expandable": "never",
      "avatar": {
        "type": "orb",
        "color_1": "#2792dc",
        "color_2": "#9ce6e6"
      },
      "feedback_mode": "none",
      "bg_color": "bg_color",
      "text_color": "text_color",
      "btn_color": "btn_color",
      "btn_text_color": "btn_text_color",
      "border_color": "border_color",
      "focus_color": "focus_color",
      "border_radius": 1,
      "btn_radius": 1,
      "action_text": "action_text",
      "start_call_text": "start_call_text",
      "end_call_text": "end_call_text",
      "expand_text": "expand_text",
      "listening_text": "listening_text",
      "speaking_text": "speaking_text",
      "shareable_page_text": "shareable_page_text",
      "shareable_page_show_terms": true,
      "terms_text": "terms_text",
      "terms_html": "terms_html",
      "terms_key": "terms_key",
      "show_avatar_when_collapsed": true,
      "disable_banner": true,
      "override_link": "override_link",
      "markdown_link_allowed_hosts": [
        {
          "hostname": "hostname"
        }
      ],
      "markdown_link_include_www": true,
      "markdown_link_allow_http": true,
      "mic_muting_enabled": true,
      "transcript_enabled": true,
      "text_input_enabled": true,
      "conversation_mode_toggle_enabled": true,
      "default_expanded": true,
      "always_expanded": true,
      "dismissible": true,
      "show_agent_status": true,
      "show_conversation_id": true,
      "strip_audio_tags": true,
      "syntax_highlight_theme": "light",
      "show_resize_button": true,
      "language_selector": false,
      "supports_text_only": true,
      "custom_avatar_path": "https://example.com/avatar.png",
      "language_presets": {
        "key": {}
      }
    },
    "data_collection": {
      "key": {
        "type": "string",
        "description": "My property",
        "is_system_provided": false,
        "dynamic_variable": "",
        "constant_value": ""
      }
    },
    "data_collection_scopes": {
      "key": "conversation"
    },
    "analysis_items": {
      "evaluation_criteria": [
        {
          "source": "system",
          "analysis_item_id": "__system_eval_criteria_sentiment"
        }
      ],
      "data_collection": [
        {
          "source": "system",
          "analysis_item_id": "__system_data_collection_topic"
        }
      ]
    },
    "overrides": {
      "custom_llm_extra_body": true,
      "enable_conversation_initiation_client_data_from_webhook": true,
      "enable_starting_workflow_node_id_from_client": true,
      "enable_procedure_ids_from_client": true
    },
    "workspace_overrides": {
      "conversation_initiation_client_data_webhook": {
        "url": "https://example.com/webhook",
        "request_headers": {
          "Content-Type": "application/json"
        }
      }
    },
    "testing": {
      "attached_tests": [
        {
          "test_id": "test_123",
          "workflow_node_id": "node_abc"
        },
        {
          "test_id": "test_456"
        }
      ]
    },
    "archived": true,
    "guardrails": {
      "version": "1"
    },
    "summary_language": "summary_language",
    "auto_translate_transcript_to_app_language": true,
    "auth": {
      "enable_auth": true,
      "allowlist": [
        {
          "hostname": "https://example.com"
        }
      ],
      "require_origin_header": true,
      "shareable_token": "1234567890"
    },
    "call_limits": {
      "agent_concurrency_limit": -1,
      "daily_limit": 100000,
      "bursting_enabled": true
    },
    "queueing_config": {
      "enabled": true,
      "wait_timeout_seconds": 1,
      "hold_audio": {
        "audio_path": "audio_path",
        "audio_url": "audio_url",
        "original_filename": "original_filename",
        "duration_secs": 1.1,
        "size_bytes": 1
      }
    },
    "privacy": {
      "record_voice": true,
      "retention_days": -1,
      "delete_transcript_and_pii": false,
      "delete_audio": false,
      "apply_to_existing_conversations": false,
      "zero_retention_mode": false
    },
    "trust_context": "unknown",
    "analysis_llm": "gpt-4o-mini",
    "alerting": {
      "monitor_configs": {
        "key": {}
      },
      "auto_resolve_after_inactive_minutes": 1,
      "notifiers": [
        {
          "type": "webhook",
          "webhook_id": "webhook_id"
        }
      ]
    },
    "safety": {
      "is_blocked_ivc": true,
      "is_blocked_non_ivc": true,
      "ignore_safety_evaluation": true
    }
  },
  "phone_numbers": [
    {
      "provider": "exotel",
      "label": "Exotel Outbound",
      "phone_number": "+919999999999",
      "phone_number_id": "phnum_X3Pbu5gP6NNKBscdCdwB",
      "assigned_agent": {
        "agent_id": "F3Pbu5gP6NNKBscdCdwB",
        "agent_name": "My Agent"
      }
    }
  ],
  "whatsapp_accounts": [
    {
      "business_account_id": "business_account_id",
      "phone_number_id": "phone_number_id",
      "business_account_name": "business_account_name",
      "phone_number_name": "phone_number_name",
      "phone_number": "phone_number",
      "account_type": "cloud_api",
      "assigned_agent_id": "assigned_agent_id",
      "enable_messaging": true,
      "enable_audio_message_response": true,
      "enable_typing_indicator": true,
      "assigned_agent_name": "assigned_agent_name",
      "is_token_expired": true
    }
  ],
  "workflow": {
    "edges": {
      "entry_to_tool_a": {
        "source": "entry_node",
        "target": "tool_node_a",
        "forward_condition": {
          "type": "llm",
          "condition": "User's last message contains a question about our pricing.",
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "start_to_entry": {
        "source": "start_node",
        "target": "entry_node",
        "forward_condition": {
          "type": "unconditional",
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_a_to_failure": {
        "source": "tool_node_a",
        "target": "failure_node",
        "forward_condition": {
          "type": "result",
          "successful": true,
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_a_to_tool_b": {
        "source": "tool_node_a",
        "target": "tool_node_b",
        "forward_condition": {
          "type": "result",
          "successful": true,
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_b_to_agent_transfer": {
        "source": "tool_node_b",
        "target": "success_transfer",
        "forward_condition": {
          "type": "unconditional",
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_b_to_conversation": {
        "source": "tool_node_b",
        "target": "success_conversation",
        "forward_condition": {
          "type": "llm",
          "condition": "User's last message contains a question about our pricing.",
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_b_to_end": {
        "source": "tool_node_b",
        "target": "success_end",
        "forward_condition": {
          "type": "llm",
          "condition": "User's last message contains a question about our pricing.",
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      },
      "tool_b_to_phone": {
        "source": "tool_node_b",
        "target": "success_phone",
        "forward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        },
        "backward_condition": {
          "type": "expression",
          "expression": {
            "type": "and_operator",
            "children": []
          },
          "label": null
        }
      }
    },
    "nodes": {
      "entry_node": {
        "type": "override_agent",
        "additional_knowledge_base": [
          {
            "type": "file",
            "name": "My Knowledge Base",
            "id": "123",
            "usage_mode": "auto"
          }
        ],
        "additional_prompt": "additional_prompt",
        "additional_tool_ids": [
          "additional_tool_ids"
        ],
        "conversation_config": {
          "asr": {
            "quality": "high",
            "provider": "scribe_realtime",
            "user_input_audio_format": "pcm_16000",
            "keywords": [
              "hello",
              "world"
            ]
          },
          "turn": {
            "turn_timeout": 7,
            "silence_end_call_timeout": -1,
            "turn_eagerness": "normal",
            "spelling_patience": "auto",
            "speculative_turn": false,
            "retranscribe_on_turn_timeout": false,
            "turn_model": "turn_v3",
            "interruption_ignore_terms": [
              "interruption_ignore_terms"
            ],
            "interruption_ignore_term_languages": [
              "interruption_ignore_term_languages"
            ],
            "merge_with_default_ignore_terms": false,
            "transcribe_on_disabled_interruptions": false,
            "soft_timeout_config": {
              "timeout_seconds": -1,
              "message": "Hhmmmm...yeah.",
              "use_llm_generated_message": false
            }
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "agent_output_audio_format": "pcm_16000",
            "optimize_streaming_latency": 3,
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8,
            "pronunciation_dictionary_locators": [
              {
                "pronunciation_dictionary_id": "pronunciation_dictionary_id",
                "version_id": null
              }
            ]
          },
          "conversation": {
            "max_duration_seconds": 600,
            "client_events": [
              "audio",
              "interruption"
            ]
          },
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "dynamic_variables": {
              "dynamic_variable_placeholders": {
                "user_name": "John Doe"
              }
            },
            "disable_first_message_interruptions": false,
            "prompt": {
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "llm": "gemini-2.0-flash-001",
              "temperature": 0,
              "max_tokens": -1,
              "tool_ids": [
                "tool_ids"
              ],
              "built_in_tools": {
                "transfer_to_agent": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "end_call": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "language_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "transfer_to_number": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "skip_turn": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "play_keypad_touch_tone": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "voicemail_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                }
              },
              "knowledge_base": [
                {
                  "type": "file",
                  "name": "My Knowledge Base",
                  "id": "123",
                  "usage_mode": "auto"
                }
              ],
              "tools": [
                {
                  "type": "api_integration_webhook",
                  "api_integration_connection_id": "api_integration_connection_id",
                  "api_integration_id": "api_integration_id",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ],
                  "description": "description",
                  "dynamic_variables": {
                    "dynamic_variable_placeholders": {
                      "user_name": "John Doe"
                    }
                  },
                  "execution_mode": "immediate",
                  "interruption_mode": "allow",
                  "name": "name",
                  "pre_tool_speech": "auto",
                  "response_timeout_secs": 1,
                  "tool_call_sound_behavior": "auto",
                  "tool_error_handling_mode": "auto",
                  "tool_version": "tool_version",
                  "disable_interruptions": true,
                  "force_pre_tool_speech": true,
                  "api_schema_overrides": null,
                  "tool_call_sound": null
                }
              ]
            }
          }
        },
        "edge_order": [
          "edge_order"
        ],
        "entry_behavior": "generate_immediately",
        "label": "label",
        "position": {
          "x": 1.1,
          "y": 1.1
        }
      },
      "failure_node": {
        "type": "override_agent",
        "additional_knowledge_base": [
          {
            "type": "file",
            "name": "My Knowledge Base",
            "id": "123",
            "usage_mode": "auto"
          }
        ],
        "additional_prompt": "additional_prompt",
        "additional_tool_ids": [
          "additional_tool_ids"
        ],
        "conversation_config": {
          "asr": {
            "quality": "high",
            "provider": "scribe_realtime",
            "user_input_audio_format": "pcm_16000",
            "keywords": [
              "hello",
              "world"
            ]
          },
          "turn": {
            "turn_timeout": 7,
            "silence_end_call_timeout": -1,
            "turn_eagerness": "normal",
            "spelling_patience": "auto",
            "speculative_turn": false,
            "retranscribe_on_turn_timeout": false,
            "turn_model": "turn_v3",
            "interruption_ignore_terms": [
              "interruption_ignore_terms"
            ],
            "interruption_ignore_term_languages": [
              "interruption_ignore_term_languages"
            ],
            "merge_with_default_ignore_terms": false,
            "transcribe_on_disabled_interruptions": false,
            "soft_timeout_config": {
              "timeout_seconds": -1,
              "message": "Hhmmmm...yeah.",
              "use_llm_generated_message": false
            }
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "agent_output_audio_format": "pcm_16000",
            "optimize_streaming_latency": 3,
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8,
            "pronunciation_dictionary_locators": [
              {
                "pronunciation_dictionary_id": "pronunciation_dictionary_id",
                "version_id": null
              }
            ]
          },
          "conversation": {
            "max_duration_seconds": 600,
            "client_events": [
              "audio",
              "interruption"
            ]
          },
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "dynamic_variables": {
              "dynamic_variable_placeholders": {
                "user_name": "John Doe"
              }
            },
            "disable_first_message_interruptions": false,
            "prompt": {
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "llm": "gemini-2.0-flash-001",
              "temperature": 0,
              "max_tokens": -1,
              "tool_ids": [
                "tool_ids"
              ],
              "built_in_tools": {
                "transfer_to_agent": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "end_call": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "language_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "transfer_to_number": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "skip_turn": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "play_keypad_touch_tone": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "voicemail_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                }
              },
              "knowledge_base": [
                {
                  "type": "file",
                  "name": "My Knowledge Base",
                  "id": "123",
                  "usage_mode": "auto"
                }
              ],
              "tools": [
                {
                  "type": "api_integration_webhook",
                  "api_integration_connection_id": "api_integration_connection_id",
                  "api_integration_id": "api_integration_id",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ],
                  "description": "description",
                  "dynamic_variables": {
                    "dynamic_variable_placeholders": {
                      "user_name": "John Doe"
                    }
                  },
                  "execution_mode": "immediate",
                  "interruption_mode": "allow",
                  "name": "name",
                  "pre_tool_speech": "auto",
                  "response_timeout_secs": 1,
                  "tool_call_sound_behavior": "auto",
                  "tool_error_handling_mode": "auto",
                  "tool_version": "tool_version",
                  "disable_interruptions": true,
                  "force_pre_tool_speech": true,
                  "api_schema_overrides": null,
                  "tool_call_sound": null
                }
              ]
            }
          }
        },
        "edge_order": [
          "edge_order"
        ],
        "entry_behavior": "generate_immediately",
        "label": "label",
        "position": {
          "x": 1.1,
          "y": 1.1
        }
      },
      "start_node": {
        "type": "start",
        "edge_order": [
          "edge_order"
        ],
        "position": {
          "x": 1.1,
          "y": 1.1
        }
      },
      "success_conversation": {
        "type": "override_agent",
        "additional_knowledge_base": [
          {
            "type": "file",
            "name": "My Knowledge Base",
            "id": "123",
            "usage_mode": "auto"
          }
        ],
        "additional_prompt": "additional_prompt",
        "additional_tool_ids": [
          "additional_tool_ids"
        ],
        "conversation_config": {
          "asr": {
            "quality": "high",
            "provider": "scribe_realtime",
            "user_input_audio_format": "pcm_16000",
            "keywords": [
              "hello",
              "world"
            ]
          },
          "turn": {
            "turn_timeout": 7,
            "silence_end_call_timeout": -1,
            "turn_eagerness": "normal",
            "spelling_patience": "auto",
            "speculative_turn": false,
            "retranscribe_on_turn_timeout": false,
            "turn_model": "turn_v3",
            "interruption_ignore_terms": [
              "interruption_ignore_terms"
            ],
            "interruption_ignore_term_languages": [
              "interruption_ignore_term_languages"
            ],
            "merge_with_default_ignore_terms": false,
            "transcribe_on_disabled_interruptions": false,
            "soft_timeout_config": {
              "timeout_seconds": -1,
              "message": "Hhmmmm...yeah.",
              "use_llm_generated_message": false
            }
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "agent_output_audio_format": "pcm_16000",
            "optimize_streaming_latency": 3,
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8,
            "pronunciation_dictionary_locators": [
              {
                "pronunciation_dictionary_id": "pronunciation_dictionary_id",
                "version_id": null
              }
            ]
          },
          "conversation": {
            "max_duration_seconds": 600,
            "client_events": [
              "audio",
              "interruption"
            ]
          },
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "dynamic_variables": {
              "dynamic_variable_placeholders": {
                "user_name": "John Doe"
              }
            },
            "disable_first_message_interruptions": false,
            "prompt": {
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "llm": "gemini-2.0-flash-001",
              "temperature": 0,
              "max_tokens": -1,
              "tool_ids": [
                "tool_ids"
              ],
              "built_in_tools": {
                "transfer_to_agent": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "end_call": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "language_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "transfer_to_number": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "skip_turn": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "play_keypad_touch_tone": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                },
                "voicemail_detection": {
                  "name": "end_call",
                  "params": {
                    "system_tool_type": "end_call"
                  },
                  "type": "system",
                  "description": "",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ]
                }
              },
              "knowledge_base": [
                {
                  "type": "file",
                  "name": "My Knowledge Base",
                  "id": "123",
                  "usage_mode": "auto"
                }
              ],
              "tools": [
                {
                  "type": "api_integration_webhook",
                  "api_integration_connection_id": "api_integration_connection_id",
                  "api_integration_id": "api_integration_id",
                  "assignments": [
                    {
                      "dynamic_variable": "user_name",
                      "value_path": "user.name",
                      "source": "response",
                      "sanitize": false,
                      "preserve_native_type": false
                    }
                  ],
                  "description": "description",
                  "dynamic_variables": {
                    "dynamic_variable_placeholders": {
                      "user_name": "John Doe"
                    }
                  },
                  "execution_mode": "immediate",
                  "interruption_mode": "allow",
                  "name": "name",
                  "pre_tool_speech": "auto",
                  "response_timeout_secs": 1,
                  "tool_call_sound_behavior": "auto",
                  "tool_error_handling_mode": "auto",
                  "tool_version": "tool_version",
                  "disable_interruptions": true,
                  "force_pre_tool_speech": true,
                  "api_schema_overrides": null,
                  "tool_call_sound": null
                }
              ]
            }
          }
        },
        "edge_order": [
          "edge_order"
        ],
        "entry_behavior": "generate_immediately",
        "label": "label",
        "position": {
          "x": 1.1,
          "y": 1.1
        }
      },
      "success_end": {
        "type": "end",
        "edge_order": [
          "edge_order"
        ],
        "position": {
          "x": 1.1,
          "y": 1.1
        }
      },
      "success_phone": {
        "type": "phone_number",
        "custom_sip_headers": [
          {
            "type": "dynamic",
            "key": "key",
            "value": "value"
          }
        ],
        "edge_order": [
          "edge_order"
        ],
        "position": {
          "x": 1.1,
          "y": 1.1
        },
        "sip_refer_play_dialtone": true,
        "transfer_destination": {
          "type": "phone",
          "phone_number": "phone_number"
        },
        "transfer_type": "blind",
        "post_dial_digits": null,
        "uui": null
      },
      "success_transfer": {
        "type": "standalone_agent",
        "delay_ms": 1,
        "edge_order": [
          "edge_order"
        ],
        "enable_transferred_agent_first_message": true,
        "position": {
          "x": 1.1,
          "y": 1.1
        },
        "preserve_client_tts_overrides": true,
        "preserve_voice_settings": true,
        "agent_id": null,
        "node_id": null,
        "transfer_message": null
      },
      "tool_node_a": {
        "type": "tool",
        "edge_order": [
          "edge_order"
        ],
        "position": {
          "x": 1.1,
          "y": 1.1
        },
        "tools": [
          {
            "tool_id": "tool_id"
          }
        ]
      },
      "tool_node_b": {
        "type": "tool",
        "edge_order": [
          "edge_order"
        ],
        "position": {
          "x": 1.1,
          "y": 1.1
        },
        "tools": [
          {
            "tool_id": "tool_id"
          }
        ]
      }
    },
    "prevent_subagent_loops": false
  },
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "tags": [
    "tags"
  ],
  "version_id": "version_id",
  "branch_id": "branch_id",
  "main_branch_id": "main_branch_id",
  "procedures": {
    "key": {
      "procedure_id": "agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3",
      "version_id": "agtprcv_7rbqxer9o12cyxi55ckw6sgz1dl4",
      "name": "Customer Support Procedure",
      "type": "free_form",
      "trigger": "When the customer asks for support",
      "referenced_tool_ids": [
        "tool_123"
      ],
      "referenced_kb_ids": [
        "kb_123"
      ],
      "referenced_procedure_ids": [
        "agtprc_other"
      ],
      "referenced_dynamic_variables": [
        "customer_id"
      ],
      "folder_parent_id": "folder_parent_id"
    }
  },
  "default_hold_audio_url": "default_hold_audio_url"
}

Retrieve config for an agent

路径参数

agent_idstring必需

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

查询参数

version_idstring可选

The ID of the agent version to use

branch_idstring可选

The ID of the branch to use

响应

Successful Response

agent_idstring

The ID of the agent

namestring

The name of the agent

conversation_configobject

The conversation configuration of the agent

metadataobject

The metadata of the agent

platform_settingsobject可选

The platform settings of the agent

phone_numberslist of objects可选

The phone numbers of the agent

whatsapp_accountslist of objects可选

WhatsApp accounts assigned to the agent

workflowobject可选

The workflow of the agent

access_infoobject可选

The access information of the agent for the user

tagslist of strings可选

Agent tags used to categorize the agent

version_idstring可选

The ID of the version the agent is on

branch_idstring可选

The ID of the branch the agent is on

main_branch_idstring可选

The ID of the main branch for this agent

proceduresmap from strings to objects可选

Procedures keyed by procedure_id.

default_hold_audio_urlstring可选默认为 https://eleven-public-cdn-common.elevenlabs.io/convai/ambient-audio-assets/elevator1.mp3

URL of the default hold tone played to queued callers when no custom hold audio is uploaded, so the dashboard can preview it.

错误

422

Agents Get Request Unprocessable Entity Error

路径参数

请求头

查询参数

响应

错误