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.
Id
Include this to update an existing scenario; omit it to add a new one.
Name*
Description*
Updated instructions for the test scenario.
Expected result*
Updated expected outcome from the agent.
Selected voices
No items yet.
Updated voice configurations for the test calls.
curl -X POST 'https://omnidim.io/api/v1/simulations/{simulation_id}/start' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "scenarios": [ { "name": "Customer asks about pricing", "description": "Caller pushes back on the monthly price.", "expected_result": "Agent explains the tiers without discounting." } ] }'
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 } }
BearerAuthheader
AuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
simulation_id*integerapplication/jsonscenarios?Optional array of scenarios to update before starting.
Response body
application/jsonSimulation started.
application/jsonsuccess?booleanmessage?stringsimulation?A test simulation for an agent.
Was this page helpful?