Skip to main content
POST
/
simulations
/
{simulationReference}
/
schedules
Create a scheduler for a simulation
curl --request POST \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectReference": "<string>",
  "runConfig": {
    "flowReferenceId": "<string>",
    "entrypoint": "<string>",
    "largeLanguageModelReferenceId": "<string>",
    "localeReferenceId": "<string>",
    "userId": "<string>",
    "finalPing": 123,
    "data": {},
    "enableMocking": true
  },
  "time": "2023-11-07T05:31:56Z",
  "runName": "<string>",
  "enableSchedule": true,
  "numberOfRuns": 123,
  "nextScheduledRun": "2023-11-07T05:31:56Z",
  "emailNotifications": [
    "<string>"
  ],
  "scenarioName": "<string>",
  "endDate": "2023-11-07T05:31:56Z"
}
'
{
  "scheduler": {
    "id": "<string>",
    "simulationReference": "<string>",
    "projectReference": "<string>",
    "organisationReference": "<string>",
    "runConfig": {
      "flowReferenceId": "<string>",
      "localeReferenceId": "<string>",
      "entrypoint": "<string>",
      "largeLanguageModelReferenceId": "<string>",
      "userId": "<string>",
      "finalPing": 123,
      "data": {},
      "enableMocking": true
    },
    "enableSchedule": true,
    "time": "2023-11-07T05:31:56Z",
    "numberOfRuns": 123,
    "nextScheduledRun": "2023-11-07T05:31:56Z",
    "emailNotifications": [
      "<string>"
    ],
    "scenarioName": "<string>",
    "runName": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "createdAt": 123,
    "lastChanged": 123,
    "createdBy": "<string>",
    "lastChangedBy": "<string>",
    "cronScheduler": "<string>",
    "timezone": "Europe/Berlin"
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Path Parameters

simulationReference
string
required

Reference ID of the simulation

Query Parameters

projectId
string
required

Project identifier

Body

application/json

Note: timezone is server-derived from project settings.

projectReference
string
required

Project reference (required in body)

runConfig
object
required
frequency
enum<string>
required
Available options:
daily,
every three days,
weekly,
biweekly,
monthly
time
string<date-time>
required
runName
string
required
enableSchedule
boolean
numberOfRuns
integer
nextScheduledRun
string<date-time>
emailNotifications
string[]
scenarioName
string
endDate
string<date-time>

Response

Scheduler created successfully

scheduler
object
Last modified on July 2, 2026