Skip to main content
POST
/
simulations
/
{simulationReference}
/
schedule
Run scenario
curl --request POST \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectReference": "<string>",
  "name": "<string>",
  "numberOfExecutions": 2,
  "runConfig": {
    "flowReferenceId": "<string>",
    "entrypoint": "<string>",
    "largeLanguageModelReferenceId": "<string>",
    "localeReferenceId": "<string>",
    "userId": "<string>",
    "data": {},
    "enableMocking": true
  },
  "endPointType": "<string>"
}
'
{
  "id": "<string>",
  "referenceId": "<string>",
  "simulationReference": "<string>",
  "runs": 123,
  "completedRuns": 123,
  "failedRuns": 123,
  "createdAt": 123,
  "startedAt": 123,
  "completedAt": 123
}

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Path Parameters

simulationReference
string
required

Reference ID of the scenario

Query Parameters

projectId
string
required

Project identifier

Body

application/json
projectReference
string
required

Project reference (required in body)

name
string
required

Name for this simulation

numberOfExecutions
integer
required

Number of simulation runs to execute in this simulation

Required range: x >= 1
runConfig
object
required

Configuration for simulation execution

endPointType
string

Endpoint type for simulation execution (e.g., 'api', 'rpc')

Response

Scenario execution started successfully

id
string
required

Unique identifier for the simulation

referenceId
string
required

Reference ID for the simulation

simulationReference
string
required

Reference ID of the simulated scenario

status
enum<string>
required

Current status of the simulation

Available options:
pending,
running,
completed,
failed,
stopped
runs
integer
required

Number of runs in this simulation

completedRuns
integer
required

Number of completed runs

failedRuns
integer
required

Number of failed runs

createdAt
integer<int64>
required

Creation timestamp

startedAt
integer<int64> | null

Start timestamp

completedAt
integer<int64> | null

Completion timestamp

Last modified on July 2, 2026