From a912037c1c4afaddffef6d644decc4ec561b6def Mon Sep 17 00:00:00 2001
From: Ivan Polomani <ivano.polomani@gmail.com>
Date: Fri, 17 Jan 2025 12:04:37 +0100
Subject: [PATCH] fix(simint): add simulation run example (#1188)

---
 packages/alpha/src/api/simulators/simulatorsApi.ts | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/packages/alpha/src/api/simulators/simulatorsApi.ts b/packages/alpha/src/api/simulators/simulatorsApi.ts
index f8d5e797f4..9c50fc33fd 100644
--- a/packages/alpha/src/api/simulators/simulatorsApi.ts
+++ b/packages/alpha/src/api/simulators/simulatorsApi.ts
@@ -141,6 +141,13 @@ export class SimulatorsAPI extends BaseResourceAPI<Simulator> {
     return this.runDataApi.retrieve(ids);
   };
 
+  /**
+   * [Run a simulation](Run a simulation <https://developer.cognite.com/api#tag/Simulation-Runs/operation/run_simulation_simulators_run_post)
+   *
+   * ```js
+   * const simulationRun = await client.simulators.runSimulation([{ "routineExternalId": "DWSIM-ShowerMixer" }]);
+   * ```
+   */
   public runSimulation = (items: SimulationRunCreate[]) => {
     return this.runsApi.run(items);
   };