GET /simulation/{simulationKey}/runs

Retrieves a list of simulation runs for a given simulation.

Path Parameters

simulationKeyrequired

The unique key of the simulation.

Request

limitoptional

Maximum number of simulation runs to return. Must be an integer between 1 and 100. Defaults to 10.

offsetoptional

Number of simulation runs to skip. Must be an integer greater than or equal to 0. Defaults to 0.

Success

Responds with a 200 OK and an array of simulation runs.

idrequired

The unique identifier for the simulation run.

simulationrequired

The key of the simulation that was run.

indexrequired

The sequential index of this run. Each run for a given simulation gets a unique integer index starting from 1.

outputrequired

The output format for this simulation run.

createdAtrequired

The timestamp when the simulation run was created.

Example

Request to get the first 2 simulation runs:

GET /simulation/my-simulation/runs?limit=2

Response:

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "simulation": "my-simulation",
    "index": 1,
    "output": "stream",
    "createdAt": "2025-04-16T15:45:30.789Z"
  },
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "simulation": "my-simulation",
    "index": 2,
    "output": "stream",
    "createdAt": "2025-04-16T16:12:45.123Z"
  }
]