SimScale · Example Payload

Simscale Create Simulation Run Example

Example request and response for starting a simulation run in SimScale.

CAECFDFEASimulationEngineering

Simscale Create Simulation Run Example is an example object payload from SimScale, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

Raw ↑ 
{
  "title": "Create Simulation Run Example",
  "description": "Example request and response for starting a simulation run in SimScale.",
  "request": {
    "method": "POST",
    "url": "https://api.simscale.com/v0/projects/proj_abc123def456/simulations/sim_xyz789/runs",
    "headers": {
      "X-API-KEY": "{api_key}",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "Run 1 - Base Case"
    }
  },
  "response": {
    "status": 201,
    "body": {
      "runId": "run_111222333",
      "name": "Run 1 - Base Case",
      "simulationId": "sim_xyz789",
      "status": "PENDING",
      "progress": 0.0,
      "startTime": "2026-05-02T10:30:00Z",
      "finishedTime": null
    }
  }
}