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

# List simulations in a run



## OpenAPI

````yaml openapi.json GET /v1/runs/{runId}/simulations
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/runs/{runId}/simulations:
    get:
      tags:
        - Runs
      summary: List simulations in a run
      operationId: listRunSimulations
      parameters:
        - name: runId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: Run ID returned by Create a run or List runs.
            examples:
              - run_01M0E4J0BBE1FVDVTZ1BSS5C97
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: pageToken
          in: query
          required: false
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: A bounded page of simulations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  simulations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        position:
                          type: integer
                        testId:
                          type: string
                          minLength: 1
                        testName:
                          type: string
                        testVersionId:
                          type: string
                          minLength: 1
                        personaId:
                          type: string
                          minLength: 1
                        personaName:
                          type: string
                        personaVersionId:
                          type: string
                          minLength: 1
                        status:
                          type: string
                          enum:
                            - queued
                            - claimed
                            - running
                            - completed
                            - failed
                            - canceled
                        gradingState:
                          anyOf:
                            - type: string
                              enum:
                                - not_requested
                                - pending
                                - running
                                - complete
                                - error
                            - type: 'null'
                        combinedScore:
                          anyOf:
                            - type: number
                              minimum: 0
                              maximum: 1
                            - type: 'null'
                        gradeTally:
                          anyOf:
                            - type: object
                              properties:
                                passed:
                                  type: integer
                                failed:
                                  type: integer
                                errored:
                                  type: integer
                                selected:
                                  type: integer
                              required:
                                - passed
                                - failed
                                - errored
                                - selected
                              additionalProperties: false
                            - type: 'null'
                        reason:
                          anyOf:
                            - type: string
                              enum:
                                - persona_concluded
                                - agent_ended
                                - limit_reached
                                - agent_never_joined
                                - not_answered
                                - capacity
                                - simulator_error
                                - orphaned
                                - dispatch_failed
                                - provider_key_unavailable
                            - type: 'null'
                        executionFailure:
                          anyOf:
                            - type: string
                            - type: 'null'
                        startedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        endedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        modality:
                          type: string
                          enum:
                            - voice
                            - chat
                        hasRecording:
                          type: boolean
                      required:
                        - id
                        - position
                        - testId
                        - testName
                        - testVersionId
                        - personaId
                        - personaName
                        - personaVersionId
                        - status
                        - gradingState
                        - combinedScore
                        - gradeTally
                        - reason
                        - executionFailure
                        - startedAt
                        - endedAt
                        - modality
                        - hasRecording
                      additionalProperties: false
                  nextPageToken:
                    anyOf:
                      - type: string
                        minLength: 1
                      - type: 'null'
                required:
                  - simulations
                  - nextPageToken
                additionalProperties: false
        '400':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '403':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '404':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '422':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````