SimScale

SimScale Simulations API

Simulation setup and configuration

GitHub OpenAPI

Operations 4

GET /v0/projects/{project_id}/simulations List Simulations #
POST /v0/projects/{project_id}/simulations Create Simulation #
GET /v0/projects/{project_id}/simulations/{simulation_id} Get Simulation #
PUT /v0/projects/{project_id}/simulations/{simulation_id} Update Simulation #

Documentation

📖
Documentation
https://www.simscale.com/docs/platform/api-and-sdk-documentation/
📖
Authentication
https://www.simscale.com/docs/platform/api-and-sdk-documentation/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/simscale/refs/heads/main/openapi/simscale-simulations-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://api.simscale.com/apidoc/swagger/index.html
🔗
PythonSDK
https://github.com/SimScaleGmbH/simscale-python-sdk
🔗
GitHubOrganization
https://github.com/SimScaleGmbH
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/simscale/refs/heads/main/rules/simscale-rules.yml

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-simulations-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

simscale-simulations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SimScale REST Geometry Simulations 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: Simulations
  description: Simulation setup and configuration
paths:
  /v0/projects/{project_id}/simulations:
    get:
      operationId: listSimulations
      summary: List Simulations
      description: Retrieve all simulations defined within a project.
      tags:
      - Simulations
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of simulations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationList'
    post:
      operationId: createSimulation
      summary: Create Simulation
      description: Create a new simulation specification within a project, specifying the physics model and geometry.
      tags:
      - Simulations
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationInput'
      responses:
        '201':
          description: Simulation created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Simulation'
  /v0/projects/{project_id}/simulations/{simulation_id}:
    get:
      operationId: getSimulation
      summary: Get Simulation
      description: Retrieve the full specification and status of a specific simulation.
      tags:
      - Simulations
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: simulation_id
        in: path
        required: true
        schema:
          type: string
        description: Unique simulation identifier
      responses:
        '200':
          description: Simulation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Simulation'
        '404':
          description: Simulation not found
    put:
      operationId: updateSimulation
      summary: Update Simulation
      description: Update the specification of an existing simulation.
      tags:
      - Simulations
      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:
              $ref: '#/components/schemas/SimulationInput'
      responses:
        '200':
          description: Simulation updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Simulation'
components:
  schemas:
    SimulationList:
      type: object
      properties:
        simulations:
          type: array
          items:
            $ref: '#/components/schemas/Simulation'
        totalCount:
          type: integer
    SimulationInput:
      type: object
      required:
      - name
      - type
      - geometryId
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - INCOMPRESSIBLE
          - COMPRESSIBLE
          - CONJUGATE_HEAT_TRANSFER
          - CONVECTIVE_HEAT_TRANSFER
          - STRUCTURAL
          - DYNAMIC
          - PEDESTRIAN_WIND_COMFORT
        geometryId:
          type: string
        model:
          type: object
          description: Physics model configuration (simulation-type specific)
          additionalProperties: true
    Simulation:
      type: object
      properties:
        simulationId:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - INCOMPRESSIBLE
          - COMPRESSIBLE
          - CONJUGATE_HEAT_TRANSFER
          - CONVECTIVE_HEAT_TRANSFER
          - STRUCTURAL
          - DYNAMIC
          - PEDESTRIAN_WIND_COMFORT
          description: Physics model type
        geometryId:
          type: string
          description: Associated geometry identifier
        status:
          type: string
          enum:
          - DRAFT
          - COMPUTED
          - INVALID
        created:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
  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/