Get a simulation session

GET

https://api.synthflow.ai/v2/simulations/session/:simulation_session_id

GET

/v2/simulations/session/:simulation_session_id

1 curl https://api.synthflow.ai/v2/simulations/session/simulation_session_id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "status": "ok",
3   "response": {
4     "simulation_session_id": "string",
5     "simulations": [
6       {
7         "simulation_id": "string",
8         "simulation_session_id": "string",
9         "simulation_case_id": "string",
10         "simulation_case_name": "string",
11         "simulation_case_prompt": "string",
12         "success_criteria": [
13           "string"
14         ],
15         "call_success_type": "all",
16         "persona_agent_id": "string",
17         "persona_phone_number": "string",
18         "target_agent_id": "string",
19         "agent_name": "string",
20         "agent_avatar_url": "string",
21         "target_phone_number": "string",
22         "target_call_id": "string",
23         "custom_variables": {},
24         "status": "in-progress",
25         "workspace_id": "string",
26         "created_at": "2024-01-15T09:30:00Z",
27         "updated_at": "2024-01-15T09:30:00Z",
28         "error_info": {
29           "message": "string",
30           "code": 1,
31           "type": "string"
32         },
33         "recording_url": "string",
34         "timeline": [
35           {
36             "sender_type": "string",
37             "value": "string",
38             "type": "string",
39             "timestamp_datetime": "2024-01-15T09:30:00Z",
40             "timestamp": 1.1
41           }
42         ],
43         "success_criteria_analysis": {
44           "success": true,
45           "evaluations": [
46             {
47               "success": true,
48               "reasoning": "string"
49             }
50           ]
51         }
52       }
53     ],
54     "total_simulations": 1,
55     "completed_simulations": 1,
56     "failed_simulations": 1,
57     "pending_simulations": 1
58   }
59 }

Retrieve simulation session details by ID.

Authentication

AuthorizationBearer

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

Path parameters

simulation_session_idstringRequiredformat: "uuid"

Simulation session ID.

Response

200

statusstring or null

Whether the request was successful.

responseobject or null

Simulation session summary.

Authentication

Path parameters

Response

Errors