Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Simulation Runs

Get simulation run by ID

Retrieve a specific simulation run by its reference ID.

get/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}

Path parameters

simulationReferencestring required

Reference ID of the scenario

simulationRunBatchReferencestring required

Reference ID of the simulation

simulationRunReferencestring required

Reference ID of the simulation run

Query parameters

projectIdstring required

Project identifier

Response

Simulation run retrieved successfully

idstring required

Unique identifier for the simulation run

organisationReferencestring required

Organization reference

projectReferencestring required

Project reference

simulationReferencestring required

Reference ID of the simulated scenario

simulationRunBatchReferencestring required

Reference ID of the simulation

sequenceinteger required

Sequence number of this run in the simulation

largeLanguageModelReferenceIdstring required

LLM reference ID used for this run

endPointTypestring

Endpoint type used for execution

totalTurnsinteger required

Total number of turns in this run

maxTurnsinteger

Maximum allowed turns

createdAtinteger required

Creation timestamp

createdBystring required

User who created this run

durationinteger

Duration of the run in milliseconds

expiresAtstring date-time

Expiration timestamp