Skip to main content
GET
/
simulations
/
{simulationReference}
/
batches
/
{simulationRunBatchReference}
/
runs
/
{simulationRunReference}
Get simulation run by ID
curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organisationReference": "<string>",
  "projectReference": "<string>",
  "simulationReference": "<string>",
  "simulationRunBatchReference": "<string>",
  "sequence": 123,
  "largeLanguageModelReferenceId": "<string>",
  "turns": [
    {
      "id": "<string>",
      "sequence": 123,
      "text": "<string>",
      "data": {},
      "createdAt": 123
    }
  ],
  "totalTurns": 123,
  "successCriteria": [
    {
      "type": "<string>",
      "params": {}
    }
  ],
  "metrics": {
    "success": true,
    "results": [
      {}
    ],
    "successRate": {
      "percentage": 123,
      "numerator": 123,
      "denominator": 123
    },
    "summary": "<string>",
    "isBatchStopped": true,
    "isConversationEnded": true,
    "errorInfo": {
      "message": "<string>",
      "technicalDetails": "<string>"
    }
  },
  "createdAt": 123,
  "createdBy": "<string>",
  "endPointType": "<string>",
  "maxTurns": 123,
  "duration": 123,
  "expiresAt": "2023-11-07T05:31:56Z"
}

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

simulationRunReference
string
required

Reference ID of the simulation run

Query Parameters

projectId
string
required

Project identifier

Response

Simulation run retrieved successfully

id
string
required

Unique identifier for the simulation run

organisationReference
string
required

Organization reference

projectReference
string
required

Project reference

simulationReference
string
required

Reference ID of the simulated scenario

simulationRunBatchReference
string
required

Reference ID of the simulation

sequence
integer
required

Sequence number of this run in the simulation

largeLanguageModelReferenceId
string
required

LLM reference ID used for this run

turns
object[]
required

Array of conversation turns

totalTurns
integer
required

Total number of turns in this run

successCriteria
object[]
required

Success criteria for this run

metrics
object
required

Metrics and results of the simulation run

createdAt
integer<int64>
required

Creation timestamp

createdBy
string
required

User who created this run

endPointType
string

Endpoint type used for execution

maxTurns
integer

Maximum allowed turns

duration
integer

Duration of the run in milliseconds

expiresAt
string<date-time>

Expiration timestamp

Last modified on July 2, 2026