Skip to main content
GET
/
simulations
/
{simulationReference}
/
batches
/
{simulationRunBatchReference}
Get simulation by ID
curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "referenceId": "<string>",
  "simulationReference": "<string>",
  "runs": 123,
  "completedRuns": 123,
  "failedRuns": 123,
  "createdAt": 123,
  "startedAt": 123,
  "completedAt": 123
}

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 retrieved successfully

id
string
required

Unique identifier for the simulation

referenceId
string
required

Reference ID for the simulation

simulationReference
string
required

Reference ID of the simulated scenario

status
enum<string>
required

Current status of the simulation

Available options:
pending,
running,
completed,
failed,
stopped
runs
integer
required

Number of runs in this simulation

completedRuns
integer
required

Number of completed runs

failedRuns
integer
required

Number of failed runs

createdAt
integer<int64>
required

Creation timestamp

startedAt
integer<int64> | null

Start timestamp

completedAt
integer<int64> | null

Completion timestamp

Last modified on July 2, 2026