List simulation cases by agent

GET

https://api.synthflow.ai/v2/simulation_cases/by_agent

GET

/v2/simulation_cases/by_agent

1 import requests
2 
3 url = "https://api.synthflow.ai/v2/simulation_cases/by_agent"
4 
5 querystring = {"agent_id":"agent_id"}
6 
7 payload = { "body": { "agent_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890" } }
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

1 {
2   "status": "ok",
3   "response": [
4     {
5       "simulation_case_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "workspace_id": "workspace-1234",
7       "name": "Customer Support Call Simulation",
8       "prompt": "Simulate a customer support call handling a billing inquiry.",
9       "type": "custom",
10       "success_criteria": [
11         "Customer issue resolved",
12         "Call duration under 5 minutes"
13       ],
14       "call_success_type": "all",
15       "base_agent": {
16         "model_id": "model-9876",
17         "agent_name": "SupportBot v2",
18         "agent_type": "virtual_assistant",
19         "voice_engine_type": "neural_tts",
20         "phone_number": "+15551234567",
21         "updated_at": "2024-01-15T09:30:00Z",
22         "image_url": "https://cdn.synthflow.ai/agents/supportbot-v2.png"
23       },
24       "created_at": "2024-01-15T09:30:00Z",
25       "updated_at": "2024-01-15T09:30:00Z"
26     }
27   ]
28 }

List all simulation cases created for a specific agent.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

agent_idstringRequired

Agent ID whose cases to list.

Response

200

statusstring

Whether the request was successful.

responselist of objects

Errors

400

Bad Request Error