SimScale

SimScale Simulation Runs API

Simulation execution and status

Documentation GitHub OpenAPI

Operations 3

GET /v0/projects/{project_id}/simulations/{simulation_id}/runs List Simulation Runs #

POST /v0/projects/{project_id}/simulations/{simulation_id}/runs Create Simulation Run #

GET /v0/projects/{project_id}/simulations/{simulation_id}/runs/{run_id} Get Simulation Run #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/simscale-simulation-runs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SimScale REST Geometry Simulation Runs API
  description: The SimScale REST API provides programmatic access to the SimScale cloud simulation platform. Manage projects, upload CAD geometry, configure meshing, run CFD/FEA/thermal simulations, and retrieve results. Requires an Enterprise plan and an API key.
  version: 0.0.0
  contact:
    name: SimScale Support
    url: https://www.simscale.com/support/
  termsOfService: https://www.simscale.com/terms-of-service/
servers:
- url: https://api.simscale.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Simulation Runs
  description: Simulation execution and status
paths:
  /v0/projects/{project_id}/simulations/{simulation_id}/runs:
    get:
      operationId: listSimulationRuns
      summary: List Simulation Runs
      description: Retrieve all execution runs for a specific simulation.
      tags:
      - Simulation Runs
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: simulation_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of simulation runs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationRunList'
    post:
      operationId: createSimulationRun
      summary: Create Simulation Run
      description: Create and start a new execution run for a simulation.
      tags:
      - Simulation Runs
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: simulation_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name for this run
      responses:
        '201':
          description: Simulation run created and started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationRun'
  /v0/projects/{project_id}/simulations/{simulation_id}/runs/{run_id}:
    get:
      operationId: getSimulationRun
      summary: Get Simulation Run
      description: Retrieve the status and progress of a specific simulation run.
      tags:
      - Simulation Runs
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: simulation_id
        in: path
        required: true
        schema:
          type: string
      - name: run_id
        in: path
        required: true
        schema:
          type: string
        description: Unique run identifier
      responses:
        '200':
          description: Simulation run details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationRun'
        '404':
          description: Run not found
components:
  schemas:
    SimulationRun:
      type: object
      properties:
        runId:
          type: string
        name:
          type: string
        simulationId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - FINISHED
          - FAILED
          - CANCELED
        progress:
          type: number
          format: float
          minimum: 0
          maximum: 100
          description: Completion percentage
        startTime:
          type: string
          format: date-time
        finishedTime:
          type: string
          format: date-time
    SimulationRunList:
      type: object
      properties:
        runs:
          type: array
          items:
            $ref: '#/components/schemas/SimulationRun'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: SimScale API key. Generate in your SimScale account settings.
externalDocs:
  description: SimScale API and SDK Documentation
  url: https://www.simscale.com/docs/platform/api-and-sdk-documentation/