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

# Retrieve an evaluator scenario

> Returns the specified evaluator scenario with full detail.



## OpenAPI

````yaml /openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/{id}
openapi: 3.1.0
info:
  version: 2.0.0
  title: Telnyx API
  x-latency-category: responsive
  x-endpoint-cost: light
  description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
    description: Version 2.0.0 of the Telnyx API
security:
  - bearerAuth: []
tags:
  - name: AI Tests
    description: >-
      Test agents, evaluator scenarios, metrics, and run results for the AI test
      framework.
paths:
  /ai/tests/test_framework/v1/scenarios/{id}:
    get:
      tags:
        - AI Tests
      summary: Retrieve an evaluator scenario
      description: Returns the specified evaluator scenario with full detail.
      operationId: retrieve_evaluator_scenario
      parameters:
        - name: id
          in: path
          required: true
          description: Numeric ID of the evaluator scenario.
          schema:
            type: integer
      responses:
        '200':
          description: Evaluator scenario detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorScenarioDetail'
              example:
                id: 9512
                name: Refund escalation flow
                agent: 1259
                project: null
                personality: 4643
                personality_name: Interruptive (High)
                tags:
                  - support
                  - regression
                tool_ids: []
                runs: []
                metrics:
                  - 266881
                  - 266882
                metric_names:
                  - AI interrupting user
                  - Average Pitch (in Hz)
                phone_number: '+13125550188'
                outbound_phone_number_data: null
                first_message: Hi, I want a refund.
                inbound_phone_number: null
                inbound_phone_number_data: null
                instructions: >-
                  Call the support line and demand a refund for a damaged
                  product.
                simulation_description: Simulates an impatient customer demanding a refund.
                information_fields: null
                expected_outcome_prompt: >-
                  The assistant explains the refund policy and offers
                  escalation.
                scenario_language: en
                scenario_type: workflow
                suite_type: predefined
                is_predefined: false
                test_profile: null
                test_profile_data: null
                dynamic_variable_values: null
                folder_path: null
                max_duration: null
        '400':
          description: Bad Request. The AI Tests service rejected the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10015'
                    title: Bad Request
                    detail: The AI Tests service rejected the request.
        '401':
          description: Unauthorized. Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10003'
                    title: Unauthorized
                    detail: The API key is missing or invalid.
        '404':
          description: >-
            Not Found. The requested resource does not exist or is not enabled
            for your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10005'
                    title: Not Found
                    detail: The requested resource or URL could not be found.
        '422':
          description: Unprocessable Entity. A validation error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10018'
                    title: Unprocessable Entity
                    detail: Validation failed for the request payload.
        '429':
          description: Too Many Requests. The AI Tests service rate-limited the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10029'
                    title: Too Many Requests
                    detail: Too many requests; retry later.
        '503':
          description: Service Unavailable. The AI Tests service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTestsErrorResponse'
              example:
                errors:
                  - code: '10063'
                    title: Service Unavailable
                    detail: The test framework service is temporarily unavailable.
components:
  schemas:
    EvaluatorScenarioDetail:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        agent:
          type:
            - integer
            - 'null'
        project:
          type:
            - integer
            - 'null'
        personality:
          type:
            - integer
            - 'null'
        personality_name:
          type: string
        tags:
          type: array
          items:
            type: string
        tool_ids:
          type: array
          items:
            type: string
        runs:
          type: array
          items:
            type: integer
        metrics:
          type: array
          items:
            type: integer
        metric_names:
          type: array
          items:
            type: string
        phone_number:
          type: string
        outbound_phone_number_data:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            number:
              type: string
            phone_number_id:
              type: string
        first_message:
          type: string
        inbound_phone_number:
          type:
            - integer
            - 'null'
        inbound_phone_number_data:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            number:
              type: string
            phone_number_id:
              type: string
        instructions:
          type: string
        simulation_description:
          type: string
        information_fields:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        expected_outcome_prompt:
          type: string
        scenario_language:
          type:
            - string
            - 'null'
        scenario_type:
          type: string
        suite_type:
          type: string
        is_predefined:
          type: boolean
        test_profile:
          type:
            - integer
            - 'null'
        test_profile_data:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            project:
              type:
                - integer
                - 'null'
            agent:
              type:
                - integer
                - 'null'
            name:
              type: string
            information:
              type:
                - object
                - 'null'
              additionalProperties:
                type: string
        dynamic_variable_values:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        folder_path:
          type:
            - string
            - 'null'
        max_duration:
          type:
            - integer
            - 'null'
      required:
        - id
        - name
        - agent
      example:
        id: 9512
        name: Refund escalation flow
        agent: 1259
        project: null
        personality: 4643
        personality_name: Interruptive (High)
        tags:
          - support
          - regression
        tool_ids: []
        runs: []
        metrics:
          - 266881
          - 266882
        metric_names:
          - AI interrupting user
          - Average Pitch (in Hz)
        phone_number: '+13125550188'
        outbound_phone_number_data: null
        first_message: Hi, I want a refund.
        inbound_phone_number: null
        inbound_phone_number_data: null
        instructions: Call the support line and demand a refund for a damaged product.
        simulation_description: Simulates an impatient customer demanding a refund.
        information_fields: null
        expected_outcome_prompt: The assistant explains the refund policy and offers escalation.
        scenario_language: en
        scenario_type: workflow
        suite_type: predefined
        is_predefined: false
        test_profile: null
        test_profile_data: null
        dynamic_variable_values: null
        folder_path: null
        max_duration: null
    AiTestsErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Telnyx error code.
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
            required:
              - code
              - title
      required:
        - errors
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````