> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run scenario

> Run multiple executions of a scenario.



## OpenAPI

````yaml https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations/{simulationReference}/schedule
openapi: 3.0.0
info:
  title: SIMULATOR OPENAPI REST-ful-API Reference
  version: 2025.20.0
  description: >

    ### Introduction

    This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation

    of the
    [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful
    SIMULATOR OPENAPI API.


    ### Cross-Origin Resource Sharing

    This API features Cross-Origin Resource Sharing (CORS) implemented in

    compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows

    cross-domain communication from the browser. All responses have a wildcard

    same-origin header which makes the API completely accessible.


    ### Authentication

    SIMULATOR OPENAPI offers following forms of authentication:

    - Bearer Token (JWT)

    - API Key


    ### Error Handling

    This API uses HTTP status codes equal or above 400 to indicate errors. Error

    details are generated in compliance with [RFC 7807 - "Problem Details for
    HTTP APIs"](https://tools.ietf.org/html/rfc7807).


    Every error response contains a traceId, which should be provided to the
    SIMULATOR OPENAPI Technical Support when reporting an error.
  contact:
    name: Cognigy Technical Support
    url: https://www.cognigy.com
    email: support@cognigy.com
  license:
    name: Cognigy Proprietary License
servers:
  - url: https://api-trial.cognigy.ai/testing
    description: Cognigy Service Testing API
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Simulations
    description: >-
      Simulation management operations - Create, read, update, and delete
      simulations
externalDocs:
  description: SIMULATOR OPENAPI Documentation
  url: https://docs.cognigy.com/docs/service-testing/
paths:
  /simulations/{simulationReference}/schedule:
    post:
      tags:
        - Simulations
      summary: Run scenario
      description: Run multiple executions of a scenario.
      operationId: scheduleSimulation
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
          description: Project identifier
        - in: path
          name: simulationReference
          required: true
          schema:
            type: string
          description: Reference ID of the scenario
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectReference:
                  type: string
                  description: Project reference (required in body)
                name:
                  type: string
                  description: Name for this simulation
                numberOfExecutions:
                  type: integer
                  description: Number of simulation runs to execute in this simulation
                  minimum: 1
                endPointType:
                  type: string
                  description: Endpoint type for simulation execution (e.g., 'api', 'rpc')
                runConfig:
                  type: object
                  description: Configuration for simulation execution
                  properties:
                    flowReferenceId:
                      type: string
                      description: Flow reference ID
                    localeReferenceId:
                      type: string
                      description: Locale reference ID (optional)
                    entrypoint:
                      type: string
                      description: Entry point for the flow
                    largeLanguageModelReferenceId:
                      type: string
                      description: LLM reference ID to use for this simulation
                    userId:
                      type: string
                      description: User ID (optional)
                    data:
                      type: object
                      description: Optional object containing arbitrary metadata
                      additionalProperties: true
                    enableMocking:
                      type: boolean
                      description: Enable mocking for this simulation run (optional)
                  required:
                    - flowReferenceId
                    - entrypoint
                    - largeLanguageModelReferenceId
              required:
                - projectReference
                - name
                - numberOfExecutions
                - runConfig
      responses:
        '201':
          description: Scenario execution started successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the simulation
                  referenceId:
                    type: string
                    description: Reference ID for the simulation
                  simulationReference:
                    type: string
                    description: Reference ID of the simulated scenario
                  status:
                    type: string
                    enum:
                      - pending
                      - running
                      - completed
                      - failed
                      - stopped
                    description: Current status of the simulation
                  runs:
                    type: integer
                    description: Number of runs in this simulation
                  completedRuns:
                    type: integer
                    description: Number of completed runs
                  failedRuns:
                    type: integer
                    description: Number of failed runs
                  createdAt:
                    type: integer
                    format: int64
                    description: Creation timestamp
                  startedAt:
                    type: integer
                    format: int64
                    nullable: true
                    description: Start timestamp
                  completedAt:
                    type: integer
                    format: int64
                    nullable: true
                    description: Completion timestamp
                required:
                  - id
                  - referenceId
                  - simulationReference
                  - status
                  - runs
                  - completedRuns
                  - failedRuns
                  - createdAt
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Validation error message
                  field:
                    type: string
                    description: Field that failed validation
                  code:
                    type: string
                    description: Validation error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
                  - field
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Unauthorized error message
                  code:
                    type: string
                    description: Unauthorized error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Forbidden error message
                  code:
                    type: string
                    description: Forbidden error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '404':
          description: Not Found - Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found error message
                  code:
                    type: string
                    description: Not found error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '500':
          description: Internal Server Error - Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer Token for authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````