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

# Trigger a test group run

> Trigger all runnable tests in a group using API-key authentication. Returns the batch ID plus `queuedRunIds` (runs accepted onto the worker) and `cancelledRunIds` (runs the server immediately cancelled, e.g. duplicates or quota cancellations). `status` is `queued` when at least one run is queued and `cancelled` when every run was rejected.



## OpenAPI

````yaml /openapi.json post /v1/groups/{groupId}/runs
openapi: 3.0.0
info:
  title: TestArmy API
  version: 1.0.0
  description: >-
    AI-powered browser automation API for QA testing. Automate web testing
    workflows using natural language prompts.
servers:
  - url: https://tester.army/api
    description: Production API server
security: []
paths:
  /v1/groups/{groupId}/runs:
    post:
      tags:
        - Groups
      summary: Trigger a test group run
      description: >-
        Trigger all runnable tests in a group using API-key authentication.
        Returns the batch ID plus `queuedRunIds` (runs accepted onto the worker)
        and `cancelledRunIds` (runs the server immediately cancelled, e.g.
        duplicates or quota cancellations). `status` is `queued` when at least
        one run is queued and `cancelled` when every run was rejected.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Test group ID
          required: true
          description: Test group ID
          name: groupId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                platform:
                  type: string
                  enum:
                    - web
                    - ios
                    - android
                  description: >-
                    Run platform for the batch. Mobile tests default to ios when
                    omitted, so Android runs must set platform: android -
                    including when the mobile app is selected by appId or
                    bundleId.
                deviceModel:
                  type: string
                  enum:
                    - iphone
                    - ipad
                  description: >-
                    Mobile device variant within the run platform (iOS: iphone |
                    ipad). Omit for the platform default phone-sized device;
                    explicitly requesting the default (e.g. iphone) is
                    equivalent to omitting it.
                projectEnvironmentId:
                  type: string
                  format: uuid
                targetUrl:
                  type: string
                  format: uri
                environment:
                  type: string
                  enum:
                    - production
                    - staging
                    - preview
                    - custom
                mobile:
                  type: object
                  properties:
                    appId:
                      type: string
                      format: uuid
                    bundleId:
                      type: string
                      minLength: 1
                    artifactUrl:
                      type: string
                      format: uri
                    artifactFilename:
                      type: string
                      minLength: 1
                    buildId:
                      type: string
                      minLength: 1
                  additionalProperties: false
                commitSha:
                  type: string
                  minLength: 1
                prNumber:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
      responses:
        '202':
          description: Group run queued successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - queued
                      - cancelled
                  groupId:
                    type: string
                    format: uuid
                  batchId:
                    type: string
                    format: uuid
                  runIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                  queuedRunIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                  cancelledRunIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                  count:
                    type: integer
                  metadata:
                    type: object
                    properties:
                      github:
                        type: object
                        properties:
                          configured:
                            type: boolean
                          checkRunCreated:
                            type: boolean
                          commentTargetResolved:
                            type: boolean
                          status:
                            type: string
                            enum:
                              - not_configured
                              - check_create_failed
                              - pr_not_found
                        required:
                          - configured
                          - checkRunCreated
                          - commentTargetResolved
                    required:
                      - github
                required:
                  - status
                  - groupId
                  - batchId
                  - runIds
                  - queuedRunIds
                  - cancelledRunIds
                  - count
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '404':
          description: Group not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '429':
          description: Too Many Requests - Usage limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '504':
          description: Gateway Timeout - Test execution exceeded time limit
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key authentication using Bearer token format

````