fix(simint): add simulation run example (#1188)

cognitedata · Jan 17, 2025 · a912037 · a912037
1 parent 637a5da
commit a912037
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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);
   };