Run tests on agent

POST

/v1/convai/agents/:agent_id/run-tests

POST

/v1/convai/agents/:agent_id/run-tests

1 from elevenlabs import ElevenLabs, SingleTestRunRequestModel
2 
3 client = ElevenLabs(
4     api_key="YOUR_API_KEY",
5 )
6 client.run_agent_test_suite_route(
7     agent_id="21m00Tcm4TlvDq8ikWAM",
8     tests=[
9         SingleTestRunRequestModel(
10             test_id="test_id",
11         )
12     ],
13 )

Try it

1 {
2   "id": "string",
3   "test_runs": [
4     {
5       "test_run_id": "string",
6       "test_invocation_id": "string",
7       "agent_id": "string",
8       "status": "pending",
9       "test_id": "string",
10       "agent_responses": [
11         {
12           "role": "user",
13           "time_in_call_secs": 1,
14           "message": "string",
15           "tool_calls": [
16             {
17               "request_id": "string",
18               "tool_name": "string",
19               "params_as_json": "string",
20               "tool_has_been_called": true,
21               "type": "system",
22               "tool_details": {
23                 "type": "webhook",
24                 "method": "string",
25                 "url": "string",
26                 "headers": {},
27                 "path_params": {},
28                 "query_params": {},
29                 "body": "string"
30               }
31             }
32           ],
33           "tool_results": [
34             {
35               "request_id": "string",
36               "tool_name": "string",
37               "result_value": "string",
38               "is_error": true,
39               "tool_has_been_called": true,
40               "tool_latency_secs": 0,
41               "dynamic_variable_updates": [
42                 {
43                   "variable_name": "string",
44                   "old_value": "string",
45                   "new_value": "string",
46                   "updated_at": 1.1,
47                   "tool_name": "string",
48                   "tool_request_id": "string"
49                 }
50               ],
51               "type": "client"
52             }
53           ],
54           "feedback": {
55             "score": "like",
56             "time_in_call_secs": 1
57           },
58           "llm_override": "string",
59           "conversation_turn_metrics": {
60             "metrics": {}
61           },
62           "rag_retrieval_info": {
63             "chunks": [
64               {
65                 "document_id": "string",
66                 "chunk_id": "string",
67                 "vector_distance": 1.1
68               }
69             ],
70             "embedding_model": "e5_mistral_7b_instruct",
71             "retrieval_query": "string",
72             "rag_latency_secs": 1.1
73           },
74           "llm_usage": {
75             "model_usage": {}
76           },
77           "interrupted": false,
78           "original_message": "string",
79           "source_medium": "audio"
80         }
81       ],
82       "condition_result": {
83         "result": "success",
84         "rationale": {
85           "messages": [
86             "string"
87           ],
88           "summary": ""
89         }
90       }
91     }
92   ],
93   "created_at": 1
94 }

Run selected tests on the agent with provided configuration. If the agent configuration is provided, it will be used to override default agent configuration.

Path parameters

agent_idstringRequired

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

Request

This endpoint expects an object.

testslist of objectsRequired

List of tests to run on the agent

agent_config_overrideobject or nullOptional

Configuration overrides to use for testing. If not provided, the agent's default configuration will be used.

Response

Successful Response

idstring

test_runslist of objects

created_atinteger or null

Run tests on agent

Path parameters

Headers

Request

Response

Errors