Resources

API Changelog

September 30, 2025

New Simulations Endpoints

We’ve added a comprehensive set of new endpoints to manage Simulation Cases, Simulation Suites, and Simulation Sessions programmatically.

  • Case Management: Create, list, retrieve, update, delete, and generate simulation cases.
  • Suite Management: Create, execute, and maintain suites that group related cases.
  • Simulation Runs & Sessions: Start simulations and review run/session data.

Simulation cases

EndpointTitle
POST /simulation_casesCreate a simulation case
GET /simulation_casesList simulation cases
GET /simulation_cases/{simulation_case_id}Get a simulation case
PUT /simulation_cases/{simulation_case_id}Update a simulation case
DELETE /simulation_cases/{simulation_case_id}Delete a simulation case
POST /simulation_cases/generateGenerate simulation cases
GET /simulation_cases/by_agentList simulation cases by agent

Simulation suites

EndpointTitle
POST /simulation_suitesCreate a simulation suite
GET /simulation_suitesList simulation suites
GET /simulation_suites/{suite_id}Get a simulation suite
PUT /simulation_suites/{suite_id}Update a simulation suite
DELETE /simulation_suites/{suite_id}Delete a simulation suite
POST /simulation_suites/{suite_id}/executeExecute a simulation suite

Simulation runs and sessions

EndpointTitle
POST /simulationsStart a simulation
GET /simulationsList simulations
GET /simulations/{simulation_id}Get a simulation
GET /simulations/sessionsList simulation sessions
GET /simulations/session/{simulation_session_id}Get a simulation session

Read more about the feature here.