Skip to main content
POST
/
workflows
/
v1
/
simulations
Create Simulation
curl --request POST \
  --url https://api-qa.interactly.ai/workflows/v1/simulations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logical_id": "<string>",
  "status": "pending",
  "name": "<string>",
  "description": "<string>",
  "selected_workflow": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "version_number": 0,
    "version_name": "<string>",
    "dynamic_variables": {},
    "name": "<string>",
    "total_events": 0,
    "total_nodes": 0,
    "total_duration_seconds": 0,
    "run_id": "5eb7cf5a86d9755df3a6c593"
  },
  "counter_workflow": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "version_number": 0,
    "version_name": "<string>",
    "dynamic_variables": {},
    "name": "<string>",
    "total_events": 0,
    "total_nodes": 0,
    "total_duration_seconds": 0,
    "run_id": "5eb7cf5a86d9755df3a6c593"
  },
  "timeout_seconds": 120,
  "max_events": 3000,
  "number_of_simulations": 1,
  "max_concurrent_runs": 1,
  "assistant_starts_first": true,
  "stop_on_failure": false,
  "run_by": "<string>"
}
'
{
  "simulation": {
    "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",
    "simulation_config": {
      "logical_id": "<string>",
      "status": "pending",
      "name": "<string>",
      "description": "<string>",
      "selected_workflow": {
        "workflow_id": "<string>",
        "version_number": 0,
        "version_name": "<string>",
        "dynamic_variables": {},
        "name": "<string>",
        "total_events": 0,
        "total_nodes": 0,
        "total_duration_seconds": 0,
        "run_id": "<string>"
      },
      "counter_workflow": {
        "workflow_id": "<string>",
        "version_number": 0,
        "version_name": "<string>",
        "dynamic_variables": {},
        "name": "<string>",
        "total_events": 0,
        "total_nodes": 0,
        "total_duration_seconds": 0,
        "run_id": "<string>"
      },
      "timeout_seconds": 120,
      "max_events": 3000,
      "number_of_simulations": 1,
      "max_concurrent_runs": 1,
      "assistant_starts_first": true,
      "stop_on_failure": false,
      "run_by": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
​
logical_id
string | null

Unique identifier for the simulation

​
status
enum<string> | null
default:pending

Current status of the simulation

Available options:
pending,
running,
completed,
failed,
cancelled
​
name
string | null

Name of the simulation

​
description
string | null

Description of the simulation

​
selected_workflow
SimulationWorkflowDetails · object

Details about the selected workflow execution

​
counter_workflow
SimulationWorkflowDetails · object

Details about the counter workflow execution

​
timeout_seconds
integer | null
default:120

Maximum time in seconds to run the simulation

​
max_events
integer | null
default:3000

Maximum number of events to process in the simulation

​
number_of_simulations
integer | null
default:1

Number of times to run the simulation

​
max_concurrent_runs
integer | null
default:1

Maximum number of concurrent simulation runs allowed

​
assistant_starts_first
boolean | null
default:true

If True, the assistant workflow will kick off first, else it will be the user workflow.

​
stop_on_failure
boolean | null
default:false

Whether to stop the simulation on failure

​
run_by
string | null

Identifier of the user or system that initiated the workflow simulation

Response

Successful Response

Response model for a single simulation. Contains a SimulationConfigModel object.

​
simulation
SimulationConfigModel · object
required

Single simulation object