For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
AcademyContact SalesHelp CenterDashboard
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
  • Get Started
    • Introduction
    • Authentication
  • Resources
    • Custom Variables
    • Dynamic Prompt Injection
    • Outbound Number Pooling
    • Timezones
  • Platform API
      • POSTCreate a simulation case
      • GETList simulation cases
      • GETGet a simulation case
      • PUTUpdate a simulation case
      • DELDelete a simulation case
      • POSTGenerate test cases
      • GETList simulation cases by agent
      • POSTCreate a simulation suite
      • GETList simulation suites
      • GETGet a simulation suite
      • PUTUpdate a simulation suite
      • DELDelete a simulation suite
      • POSTExecute a simulation suite
      • POSTCreate a simulation scenario
      • GETList simulation scenarios
      • GETGet a simulation scenario
      • PUTUpdate a simulation scenario
      • DELDelete a simulation scenario
      • POSTStart a simulation
      • GETList simulation sessions
      • GETGet a simulation session
      • GETList simulations
      • GETGet a simulation
LogoLogo
AcademyContact SalesHelp CenterDashboard
Platform APISimulations

Get a simulation session

||View as Markdown|
GET
/simulations/session/:simulation_session_id
GET
/v2/simulations/session/:simulation_session_id
$curl https://api.synthflow.ai/v2/simulations/session/simulation_session_id \
>     -H "Authorization: Bearer <token>"
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.
Was this page helpful?
Previous

List simulations

Next
Built with

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
Whether the request was successful.
responseobject
Simulation session summary.

Errors

404
Not Found Error
422
Unprocessable Entity Error