Get a simulation | Synthflow

curl https://api.synthflow.ai/v2/simulations/simulation_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "ok",
  "response": {
    "simulation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "simulation_session_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "simulation_case_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "simulation_case_name": "Customer Support Call Simulation",
    "simulation_case_prompt": "Simulate a customer support call handling a billing inquiry.",
    "success_criteria": [
      "Customer issue resolved",
      "Call completed within 5 minutes",
      "Polite and professional tone maintained"
    ],
    "call_success_type": "all",
    "persona_agent_id": "9f8c1a2b-3d4e-4f5a-8b7c-123456789abc",
    "persona_phone_number": "+14155552671",
    "target_agent_id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "agent_name": "Alice Johnson",
    "agent_avatar_url": "https://example.com/avatars/alice_johnson.png",
    "target_phone_number": "+14155559876",
    "target_call_id": "call-20240115-093000-xyz",
    "custom_variables": {
      "priority_level": "high",
      "customer_type": "premium"
    },
    "status": "in-progress",
    "workspace_id": "workspace-12345",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:45:00Z",
    "error_info": {
      "message": "No errors detected",
      "code": 0,
      "type": "none"
    },
    "recording_url": "https://recordings.synthflow.ai/recordings/3fa85f64-5717-4562-b3fc-2c963f66afa6.mp3",
    "timeline": [
      {
        "sender_type": "agent",
        "value": "Hello, thank you for calling customer support. How can I assist you today?",
        "type": "speech",
        "timestamp_datetime": "2024-01-15T09:30:05Z",
        "timestamp": 5
      },
      {
        "sender_type": "customer",
        "value": "I have a question about my latest bill.",
        "type": "speech",
        "timestamp_datetime": "2024-01-15T09:30:15Z",
        "timestamp": 15
      }
    ],
    "success_criteria_analysis": {
      "success": true,
      "evaluations": [
        {
          "success": true,
          "reasoning": "The customer issue was resolved within the expected time frame."
        },
        {
          "success": true,
          "reasoning": "The call duration was under 5 minutes."
        },
        {
          "success": true,
          "reasoning": "The agent maintained a polite and professional tone throughout the call."
        }
      ]
    }
  }
}

Retrieve a simulation by ID.

Authentication

AuthorizationBearer

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

Path parameters

simulation_idstringRequiredformat: "uuid"

Simulation ID.

Response

200

statusstring

Whether the request was successful.

responseobject

Simulation details.

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error