List simulation cases by agent

GET

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

GET

/v2/simulation_cases/by_agent

1 curl -G https://api.synthflow.ai/v2/simulation_cases/by_agent \
2      -H "Authorization: Bearer <token>" \
3      -d agent_id=agent_id

Try it

200Retrieved

1 {
2   "status": "ok",
3   "response": [
4     {
5       "simulation_case_id": "string",
6       "workspace_id": "string",
7       "name": "string",
8       "prompt": "string",
9       "type": "custom",
10       "success_criteria": [
11         "string"
12       ],
13       "call_success_type": "all",
14       "base_agent": {
15         "model_id": "string",
16         "agent_name": "string",
17         "agent_type": "string",
18         "voice_engine_type": "string",
19         "phone_number": "string",
20         "updated_at": "2024-01-15T09:30:00Z",
21         "image_url": "string"
22       },
23       "created_at": "2024-01-15T09:30:00Z",
24       "updated_at": "2024-01-15T09:30:00Z"
25     }
26   ]
27 }

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 or null

Whether the request was successful.

responselist of objects or null

Authentication

Query parameters

Response

Errors