Simulate conversation

Deprecated

POST

/v1/convai/agents/:agent_id/simulate-conversation

POST

/v1/convai/agents/:agent_id/simulate-conversation

$ curl -X POST https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/simulate-conversation \
>      -H "Content-Type: application/json" \
>      -d '{
>   "simulation_specification": {
>     "simulated_user_config": {
>       "first_message": "Hello, how can I help you today?",
>       "language": "en",
>       "disable_first_message_interruptions": false
>     }
>   }
> }'

1 {
2   "simulated_conversation": [
3     {
4       "role": "user",
5       "time_in_call_secs": 1,
6       "agent_metadata": {
7         "agent_id": "agent_id"
8       },
9       "message": "message",
10       "multivoice_message": {
11         "parts": [
12           {
13             "text": "text",
14             "voice_label": null,
15             "time_in_call_secs": null
16           }
17         ]
18       },
19       "tool_calls": [
20         {
21           "request_id": "request_id",
22           "tool_name": "tool_name",
23           "params_as_json": "params_as_json",
24           "tool_has_been_called": true
25         }
26       ],
27       "tool_results": [
28         {
29           "is_error": true,
30           "request_id": "request_id",
31           "result_value": "result_value",
32           "tool_has_been_called": true,
33           "tool_name": "tool_name"
34         }
35       ],
36       "feedback": {
37         "score": "like",
38         "time_in_call_secs": 1
39       },
40       "llm_override": "llm_override",
41       "rag_retrieval_info": {
42         "chunks": [
43           {
44             "document_id": "document_id",
45             "chunk_id": "chunk_id",
46             "vector_distance": 1.1
47           }
48         ],
49         "embedding_model": "e5_mistral_7b_instruct",
50         "retrieval_query": "retrieval_query",
51         "rag_latency_secs": 1.1
52       },
53       "interrupted": true,
54       "original_message": "original_message",
55       "reasoning": [
56         {}
57       ],
58       "source_medium": "audio",
59       "source_event_id": 1,
60       "used_static_kb_document_ids": [
61         "used_static_kb_document_ids"
62       ],
63       "user_identifier": "user_identifier",
64       "file_input": {
65         "file_id": "file_id",
66         "original_filename": "original_filename",
67         "mime_type": "mime_type",
68         "file_url": "file_url"
69       },
70       "contextual_update_info": {
71         "context_id": "context_id"
72       },
73       "reasoned": true
74     }
75   ],
76   "analysis": {
77     "call_successful": "success",
78     "transcript_summary": "transcript_summary",
79     "evaluation_criteria_results": {
80       "key": {
81         "criteria_id": "criteria_id",
82         "result": "success",
83         "rationale": "rationale"
84       }
85     },
86     "data_collection_results": {
87       "key": {
88         "data_collection_id": "data_collection_id",
89         "rationale": "rationale",
90         "json_schema": {
91           "type": "string",
92           "description": "A user-provided message"
93         }
94       }
95     },
96     "evaluation_criteria_results_list": [
97       {
98         "criteria_id": "criteria_id",
99         "result": "success",
100         "rationale": "rationale"
101       }
102     ],
103     "data_collection_results_list": [
104       {
105         "data_collection_id": "data_collection_id",
106         "rationale": "rationale",
107         "json_schema": {
108           "type": "string",
109           "description": "A user-provided message"
110         }
111       }
112     ],
113     "call_success_score": 1.1,
114     "call_summary_title": "call_summary_title",
115     "scoped": [
116       {
117         "scope": "conversation",
118         "source_agent_id": "source_agent_id",
119         "successful": "success"
120       }
121     ]
122   }
123 }

Deprecated. Use the /v1/convai/agent-testing/create and /v1/convai/agents/:agent_id/run-tests endpoints to create and run simulations. Run a conversation between the agent and a simulated user.

Path parameters

agent_idstringRequired

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

Request

This endpoint expects an object.

simulation_specificationobjectRequired

A specification detailing how the conversation should be simulated

extra_evaluation_criterialist of objectsOptional

A list of evaluation criteria to test

new_turns_limitintegerOptionalDefaults to 10000

Maximum number of new turns to generate in the conversation simulation

Response

Successful Response

simulated_conversationlist of objects

analysisobject

Errors

422

Agents Simulate Conversation Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors