> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interactly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Simulation Run Details

> Get details of a specific simulation group run.



## OpenAPI

````yaml https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{run_id}
openapi: 3.1.0
info:
  title: Interactly API
  description: API for building interactly.ai services
  version: 1.1.0
  contact:
    name: Interactly
    url: https://interactly.ai
    email: developers@interactly.ai
servers:
  - url: https://api-prod.interactly.ai
    description: API Server
security: []
paths:
  /workflows/v1/simulation-runs/{run_id}:
    get:
      tags:
        - Simulations
      summary: Get Simulation Run Details
      description: Get details of a specific simulation group run.
      operationId: >-
        workflow_service_get_simulation_run_details_v1_simulation_runs__run_id__get
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/PydanticObjectId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationGroupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearer: []
components:
  schemas:
    PydanticObjectId:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[0-9a-f]{24}$
      example: 5eb7cf5a86d9755df3a6c593
    SimulationGroupResponse:
      properties:
        simulation_group:
          $ref: '#/components/schemas/SimulationGroupModel'
          description: Simulation group object
      type: object
      required:
        - simulation_group
      title: SimulationGroupResponse
      description: Response model for a simulation group run.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SimulationGroupModel:
      properties:
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the team that owns this edge
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the user who created this edge
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the user who last updated this edge
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        _id:
          anyOf:
            - $ref: '#/components/schemas/PydanticObjectId'
            - type: 'null'
          description: MongoDB document ObjectID
        simulation_config_id:
          $ref: '#/components/schemas/PydanticObjectId'
          description: Reference to the SimulationConfigModel
        status:
          $ref: '#/components/schemas/SimulationStatus'
          description: Status of the overall simulation group
          default: pending
        total_runs:
          type: integer
          title: Total Runs
          description: Total number of runs requested
          default: 0
        completed_runs:
          type: integer
          title: Completed Runs
          description: Number of runs completed
          default: 0
        failed_runs:
          type: integer
          title: Failed Runs
          description: Number of runs failed
          default: 0
      type: object
      required:
        - simulation_config_id
      title: SimulationGroupModel
      description: Stores the batch/group of simulation runs.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SimulationStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled
      title: SimulationStatus
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: Bearer
      type: http
      description: >-
        Retrieve your API Key from [Dashboard API Keys
        Section](https://dashboard.interactly.ai/api-keys).

````