---
title: "Run scenario"
method: POST
path: "/simulations/{simulationReference}/schedule"
tags: ["Simulations"]
---

# Run scenario

`POST /simulations/{simulationReference}/schedule`

Run multiple executions of a scenario.

## Path parameters

- `simulationReference` string, required

## Query parameters

- `projectId` string, required

## Request body

- object
  - `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
  - `endPointType` string — Endpoint type for simulation execution (e.g., 'api', 'rpc')
  - `runConfig` object, required — Configuration for simulation execution
    - `flowReferenceId` string, required — Flow reference ID
    - `localeReferenceId` string — Locale reference ID (optional)
    - `entrypoint` string, required — Entry point for the flow
    - `largeLanguageModelReferenceId` string, required — LLM reference ID to use for this simulation
    - `userId` string — User ID (optional)
    - `data` object — Optional object containing arbitrary metadata
    - `enableMocking` boolean — Enable mocking for this simulation run (optional)

## Response `201`

Scenario execution started successfully

- object
  - `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` 'pending' | 'running' | 'completed' | 'failed' | 'stopped', required — Current status of the simulation
  - `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, required — Creation timestamp
  - `startedAt` integer, nullable — Start timestamp
  - `completedAt` integer, nullable — Completion timestamp

## Other responses

- `400` — Bad Request - Invalid input parameters
- `401` — Unauthorized - Invalid or missing authentication
- `403` — Forbidden - Insufficient permissions
- `404` — Not Found - Resource not found
- `500` — Internal Server Error - Server error

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)