Simulations
Stop simulation
Stop a running simulation and all its active runs.
post/simulations/{simulationReference}/batches/{simulationRunBatchReference}
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
simulationReferencestring required
Reference ID of the scenario
simulationRunBatchReferencestring required
Reference ID of the simulation
Query parameters
projectIdstring required
Project identifier
Response
Simulation stop signal sent successfully
Example response
{
"message": "Simulation stop signal sent successfully."
}Changes
No recorded changes to this operation across all 1 revision of this API.