Skip to main content
POST
/
workflows
/
v1
/
simulations
/
{simulation_id}
/
run
Run Simulation
curl --request POST \
  --url https://api-qa.interactly.ai/workflows/v1/simulations/{simulation_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "runner_name": "<string>"
}
'
{
  "simulation_group": {
    "simulation_config_id": "5eb7cf5a86d9755df3a6c593",
    "team_id": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "status": "pending",
    "total_runs": 0,
    "completed_runs": 0,
    "failed_runs": 0
  }
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

simulation_id
string
required
Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
runner_name
string | null

Name of the user running the simulation

Response

Successful Response

Response model for a simulation group run.

simulation_group
SimulationGroupModel · object
required

Simulation group object