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

# Execute a test run

> Triggers the execution of a specified test run. The execution can be customized to include or exclude specific scenarios.



## OpenAPI

````yaml /openapi.json post /simulate/run-tests/{run_test_id}/execute/
openapi: 3.0.0
info:
  title: FutureAGI Unified API
  version: 1.0.0
  description: >-
    Complete API documentation for FutureAGI platform - Simulate module
    (scenario management, agent definitions, test executions, call analytics)
    and Model Hub Evaluations API (evaluation templates, playgrounds, metrics,
    and execution tracking)
  contact:
    email: support@futureagi.com
servers:
  - url: https://api.futureagi.com
    description: Production API
security: []
tags:
  - name: Health
    description: Health check operations for monitoring server status
  - name: Authentication
    description: User authentication and token management
  - name: Scenarios
    description: Test scenario management and execution
  - name: Agent Definitions
    description: Agent definition CRUD operations
  - name: Agent Versions
    description: Agent version control and management
  - name: Simulator Agents
    description: Simulator agent operations
  - name: Run Tests
    description: Test execution management
  - name: Test Executions
    description: Test execution tracking and analytics
  - name: Call Executions
    description: Individual call execution details
  - name: Call Transcripts
    description: Transcript management and retrieval
  - name: Personas
    description: Persona management for testing
  - name: Analytics
    description: Analytics and reporting
  - name: Export Simulate
    description: Data export operations
  - name: Datasets
    description: >-
      Operations related to datasets, including creation, modification, and data
      management.
  - name: Eval Groups
    description: Evaluation group management
  - name: Eval Templates
    description: Base evaluation template operations
  - name: Custom Eval Templates
    description: Custom evaluation template CRUD operations
  - name: Eval Playground
    description: Test and run evaluations in playground environment
  - name: Eval Logs & Metrics
    description: Evaluation logs, metrics, and execution tracking
  - name: Eval Configuration
    description: Evaluation configuration and templates retrieval
  - name: API Keys
    description: API key management
  - name: Prompt Workbench
    description: Prompt template version labeling and lookup by name, version, or label
paths:
  /simulate/run-tests/{run_test_id}/execute/:
    post:
      tags:
        - Run Tests
      summary: Execute a test run
      description: >-
        Triggers the execution of a specified test run. The execution can be
        customized to include or exclude specific scenarios.
      operationId: executeRunTest
      parameters:
        - name: run_test_id
          in: path
          required: true
          description: The UUID of the test run to execute.
          schema:
            type: string
            format: uuid
      requestBody:
        description: >-
          Configuration for the test execution, specifying which scenarios to
          run.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                selectAll:
                  type: boolean
                  default: false
                  description: >-
                    Determines how `scenarioIds` is interpreted. If `true`, all
                    scenarios *except* those in `scenarioIds` will be executed.
                    If `false`, *only* the scenarios in `scenarioIds` will be
                    executed. If `scenarioIds` is empty, all scenarios will run
                    regardless of this flag.
                scenarioIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    A list of scenario UUIDs to either include or exclude from
                    the execution, based on the `selectAll` flag.
                simulatorId:
                  type: string
                  format: uuid
                  nullable: true
                  description: >-
                    An optional UUID of a specific simulator to use for the test
                    run.
            examples:
              run-specific-scenarios:
                summary: Run a specific list of scenarios
                value:
                  selectAll: false
                  scenarioIds:
                    - <scenario_id>
              run-all-except-specific:
                summary: Run all scenarios except for a specific list
                value:
                  selectAll: true
                  scenarioIds:
                    - <scenario_id>
              run-all-scenarios:
                summary: Run all scenarios associated with the test
                value:
                  selectAll: true
                  scenarioIds: []
      responses:
        '200':
          description: Test execution started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Test execution started successfully
                  execution_id:
                    type: string
                    format: uuid
                  run_test_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    example: PENDING
                  total_scenarios:
                    type: integer
                  total_calls:
                    type: integer
                  scenario_ids:
                    type: array
                    items:
                      type: string
                      format: uuid
        '400':
          description: >-
            Bad Request. The execution failed to start, possibly due to an issue
            with the test configuration.
        '401':
          description: >-
            Unauthorized. Authentication credentials were not provided or are
            invalid.
        '404':
          description: >-
            Not Found. The specified test run or organization could not be
            found.
        '500':
          description: >-
            Internal Server Error. An unexpected error occurred while trying to
            execute the test.
      security:
        - ApiKeyAuth: []
          SecretKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access API Key
    SecretKeyAuth:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access Secret Key

````