---
title: "Create a simulation run"
method: POST
path: "/projects/{projectId}/simulations/{simulationId}/runs"
tags: ["Simulation Runs"]
---

# Create a simulation run

`POST /projects/{projectId}/simulations/{simulationId}/runs`

This operation creates a run in status `READY`, however the run is not automatically started. The run must be started explicitly using the `POST /projects/{projectId}/simulations/{simulationId}/runs/{runId}/start` endpoint.

## Request body

- SimulationRun
  - `runId` string, uuid
  - `name` string, required — The name of the simulation run.
  - `createdAt` string, date-time — The time when the simulation run was created.
  - `startedAt` string, date-time — The time when the simulation run was started.
  - `finishedAt` string, date-time — The time when the simulation run was finished.
  - `duration` string, duration — The actual duration of the simulation run.
  - `computeResource` SimulationRunComputeResource — The actual compute resources (CPUh or GPUh) consumed by the simulation run.
    - `type` 'CPU_HOURS' | 'GPU_HOURS'
    - `value` number, double
  - `status` 'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED' — Status of the operation.
  - `progress` number — The current progress while the simulation run is in progress.

## Response `201`

Successful creation of the simulation run

- SimulationRun
  - `runId` string, uuid
  - `name` string, required — The name of the simulation run.
  - `createdAt` string, date-time — The time when the simulation run was created.
  - `startedAt` string, date-time — The time when the simulation run was started.
  - `finishedAt` string, date-time — The time when the simulation run was finished.
  - `duration` string, duration — The actual duration of the simulation run.
  - `computeResource` SimulationRunComputeResource — The actual compute resources (CPUh or GPUh) consumed by the simulation run.
    - `type` 'CPU_HOURS' | 'GPU_HOURS'
    - `value` number, double
  - `status` 'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED' — Status of the operation.
  - `progress` number — The current progress while the simulation run is in progress.

## Other responses

- `400` — Bad request.
- `404` — Not found.

---

[API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)
