November 21, 2025 | Synthflow

Simulations Updates

Based on user feedback, we have made changes to Simulations with a comprehensive set of new endpoints to manage Test Cases, Test Suites, and Simulation Sessions programmatically.

Key changes:

Test suites are attached to specific agents and can only run on the agent they were designed for
Test case generation now supports flow builder agents
All of your previously created Agent-based tests will now be grouped into a Test Suite.
Your Custom test cases will also be grouped, based on the most recently updated agent on your workspace. These changes are designed to make your test management clearer and more organised.
Scenarios are separate entities used when generating test cases to ensure coverage of specific situations

Simulation cases

Endpoint	Title
POST /simulation_cases	Create a test case
GET /simulation_cases	List test cases
GET /simulation_cases/{simulation_case_id}	Get a test case
PUT /simulation_cases/{simulation_case_id}	Update a test case
DELETE /simulation_cases/{simulation_case_id}	Delete a test case
POST /simulation_cases/generate	Generate test cases for an agent
GET /simulation_cases/by_agent	List test cases by agent

Simulation suites

Endpoint	Title
POST /simulation_suites	Create a test suite
GET /simulation_suites	List test suites
GET /simulation_suites/{suite_id}	Get a test suite
PUT /simulation_suites/{suite_id}	Update a test suite
DELETE /simulation_suites/{suite_id}	Delete a test suite
POST /simulation_suites/{suite_id}/execute	Execute a test suite

Simulation runs and sessions

Endpoint	Title
POST /simulations	Start a simulation
GET /simulations	List simulations
GET /simulations/{simulation_id}	Get a simulation
GET /simulations/sessions	List simulation sessions
GET /simulations/session/{simulation_session_id}	Get a simulation session

Upcoming Changes

The following changes are planned for simulation case CRUD endpoints:

Field Deprecation:

The type field in simulation case payloads is deprecated and will be removed in a future version. Please remove this field from your API requests.

New Required Fields: In upcoming releases, the following fields will become mandatory:

suite_id — Test suite identifier. All simulation cases must be associated with a suite.
base_agent_id — The agent ID the test case is based on. This ensures proper association between test cases and agents.

Please update your integrations to include these fields to ensure compatibility with future API versions.

Analytics Export: Date-Time Parameters

The from_date and to_date parameters in the analytics export endpoint now accept datetime values instead of date-only values, allowing for more precise time-based filtering.

Changes:

from_date and to_date parameters now use date-time format instead of date format
Both parameters accept ISO 8601 datetime strings (e.g., 2025-11-25T14:30:00Z)

Endpoint	Title
GET /analytics	Analytics export