> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

## 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**](/api-reference/platform-api/simulations/create-simulation-case)                           | Create a test case               |
| [**GET /simulation\_cases**](/api-reference/platform-api/simulations/list-simulation-cases)                             | List test cases                  |
| [**GET /simulation\_cases/\{simulation\_case\_id}**](/api-reference/platform-api/simulations/get-simulation-case)       | Get a test case                  |
| [**PUT /simulation\_cases/\{simulation\_case\_id}**](/api-reference/platform-api/simulations/update-simulation-case)    | Update a test case               |
| [**DELETE /simulation\_cases/\{simulation\_case\_id}**](/api-reference/platform-api/simulations/delete-simulation-case) | Delete a test case               |
| [**POST /simulation\_cases/generate**](/api-reference/platform-api/simulations/generate-simulation-cases)               | Generate test cases for an agent |
| [**GET /simulation\_cases/by\_agent**](/api-reference/platform-api/simulations/list-simulation-cases-by-agent)          | List test cases by agent         |

### Simulation suites

| Endpoint                                                                                                              | Title                |
| --------------------------------------------------------------------------------------------------------------------- | -------------------- |
| [**POST /simulation\_suites**](/api-reference/platform-api/simulations/create-simulation-suite)                       | Create a test suite  |
| [**GET /simulation\_suites**](/api-reference/platform-api/simulations/list-simulation-suites)                         | List test suites     |
| [**GET /simulation\_suites/\{suite\_id}**](/api-reference/platform-api/simulations/get-simulation-suite)              | Get a test suite     |
| [**PUT /simulation\_suites/\{suite\_id}**](/api-reference/platform-api/simulations/update-simulation-suite)           | Update a test suite  |
| [**DELETE /simulation\_suites/\{suite\_id}**](/api-reference/platform-api/simulations/delete-simulation-suite)        | Delete a test suite  |
| [**POST /simulation\_suites/\{suite\_id}/execute**](/api-reference/platform-api/simulations/execute-simulation-suite) | Execute a test suite |

### Simulation runs and sessions

| Endpoint                                                                                                                  | Title                    |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| [**POST /simulations**](/api-reference/platform-api/simulations/start-simulation)                                         | Start a simulation       |
| [**GET /simulations**](/api-reference/platform-api/simulations/list-simulations)                                          | List simulations         |
| [**GET /simulations/\{simulation\_id}**](/api-reference/platform-api/simulations/get-simulation)                          | Get a simulation         |
| [**GET /simulations/sessions**](/api-reference/platform-api/simulations/list-simulation-sessions)                         | List simulation sessions |
| [**GET /simulations/session/\{simulation\_session\_id}**](/api-reference/platform-api/simulations/get-simulation-session) | 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.

Read more about the feature [here.](/simulations)

## 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**](/api-reference/platform-api/analytics/analytics-export) | Analytics export |