PATCH /simulations/{key}

Partially updates an existing simulation. Only the fields provided in the request body will be updated.

Path Parameters

The unique key of the simulation to update.

Request

The seed for the simulation's random number generator. Must be an integer greater than or equal to 1.

An object of named systems to be used by the simulation. Systems define how to import data.

An object of named entities to be simulated.

Success

Upon success, responds with a 200 OK with a simulation body.

A unique identifier.

The key of the parent simulation, if any.

The seed for the simulation's random number generator. Must be an integer greater than or equal to 1.

The timestamp when the simulation was created.

The timestamp when the simulation was last updated.

Failure

Responds with a 400 Bad Request if the request body is invalid or contains validation errors.

Responds with a 404 Not Found if a simulation with the specified key does not exist.

Example

Update the seed of a simulation:

PATCH /simulations/my-simulation
Content-Type: application/json

{
  "seed": 42
}

Response:

{
  "key": "my-simulation",
  "parent": "default",
  "seed": 42,
  "createdAt": "2025-04-16T14:22:15.123Z",
  "updatedAt": "2025-04-16T15:30:00.456Z"
}