INinteractly
Simulations

Run Simulation

Trigger a new simulation batch run from a configuration.

post/workflows/v1/simulations/{simulation_id}/run

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/simulations/{simulation_id}/run
  • Auth
    HTTP bearer

Path parameters

simulation_idstring required
Example:5eb7cf5a86d9755df3a6c593

Request body

runner_namestring nullable

Name of the user running the simulation

Response

Successful Response

Example response

{
  "simulation_group": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "simulation_config_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Changes

No recorded changes to this operation across all 60 revisions of this API.