Stop simulation - Cognigy Documentation

POST

simulations

{simulationReference}

batches

{simulationRunBatchReference}

Stop simulation

curl --request POST \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Simulation stop signal sent successfully.",
  "simulationRunBatchId": "<string>"
}

Authorizations

Authorization

string

header

required

JWT Bearer Token for authentication

Path Parameters

simulationReference

string

required

Reference ID of the scenario

simulationRunBatchReference

string

required

Reference ID of the simulation

Query Parameters

projectId

string

required

Project identifier

Response

Simulation stop signal sent successfully

message

string

required

Success message

Example:

"Simulation stop signal sent successfully."

simulationRunBatchId

string

required

Reference ID of the simulation that was signaled to stop

Last modified on July 2, 2026

Clone scenarioClone a scenario and optionally provide a new name for the cloned scenario.

Stop simulation

curl --request POST \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Simulation stop signal sent successfully.",
  "simulationRunBatchId": "<string>"
}