Simulation
Start simulation
Begin running a simulation. Optionally update scenarios at start time (same shape as Update simulation).
POST/simulations//start
Bearersession
Path parameters
simulation_idrequiredBody
Optional array of scenarios to update before starting.
No items yet.
curl -X POST 'https://backend.omnidim.io/api/v1/simulations/{simulation_id}/start' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{}'
Example response
{ "success": true, "message": "Simulation started successfully", "simulation": { "id": 456, "name": "Customer Support Test", "status": "Pending", "number_of_call_to_make": 1, "concurrent_call_count": 3, "max_call_duration_in_minutes": 3 } }
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Path Parameters
simulation_id*integer
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json