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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Read one test suite

> Read one test suite with the scenarios filed in it, named. An id the project does not hold, and a run plan id, both answer 404 suite_not_found.



## OpenAPI

````yaml GET /api/v1/test-suites/{id}
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/test-suites/{id}:
    get:
      tags:
        - Test Suites
      summary: Read one test suite
      description: >-
        Read one test suite with the scenarios filed in it, named. An id the
        project does not hold, and a run plan id, both answer 404
        suite_not_found.
      operationId: getTestSuite
      parameters:
        - in: path
          name: id
          schema:
            type: string
            minLength: 1
          required: true
          description: The test suite id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The test suite id.
                  name:
                    type: string
                    description: The test suite name.
                  slug:
                    type: string
                    description: >-
                      The suite's address in the platform. It is kept when the
                      suite is renamed.
                  scenarioIds:
                    type: array
                    items:
                      type: string
                    description: >-
                      The scenarios filed in this suite, in the order it shows
                      them.
                  scenarioCount:
                    type: number
                    description: How many scenarios are filed in it.
                  fields:
                    description: >-
                      The fields the test suite declares. Absent on servers that
                      predate fields on this family.
                    maxItems: 30
                    type: array
                    items:
                      type: object
                      properties:
                        identifier:
                          type: string
                          minLength: 1
                          maxLength: 64
                          pattern: ^[a-z][a-z0-9_]*$
                          description: >-
                            The field name, as scenarios and evaluator mappings
                            address it. Lowercase letters, digits and
                            underscores, starting with a letter.
                        type:
                          type: string
                          enum:
                            - text
                            - number
                            - boolean
                          description: >-
                            The value type every scenario carries for this
                            field.
                      required:
                        - identifier
                        - type
                      additionalProperties: false
                      description: >-
                        One field the test suite declares beyond situation and
                        criteria. Every scenario filed in the suite carries a
                        value for it.
                  evaluators:
                    description: >-
                      The evaluators attached to the test suite. Absent on
                      servers that predate evaluators on this family.
                    maxItems: 20
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          maxLength: 64
                          description: >-
                            The attachment id. Stable across edits of the
                            attachment.
                        evaluatorId:
                          type: string
                          minLength: 1
                          description: The id of the saved evaluator this attachment runs.
                        required:
                          type: boolean
                          description: >-
                            Whether a failing result fails the scenario. A
                            score-only evaluator reports and never gates.
                        mappings:
                          type: object
                          propertyNames:
                            type: string
                            minLength: 1
                            maxLength: 128
                          additionalProperties:
                            oneOf:
                              - type: object
                                properties:
                                  type:
                                    type: string
                                    const: source
                                  sourceId:
                                    type: string
                                    enum:
                                      - conversation
                                      - scenario
                                      - trace
                                  path:
                                    minItems: 1
                                    maxItems: 3
                                    type: array
                                    items:
                                      type: string
                                      minLength: 1
                                      maxLength: 256
                                required:
                                  - type
                                  - sourceId
                                  - path
                                additionalProperties: false
                              - type: object
                                properties:
                                  type:
                                    type: string
                                    const: value
                                  value:
                                    type: string
                                    maxLength: 65536
                                required:
                                  - type
                                  - value
                                additionalProperties: false
                            description: >-
                              Where one evaluator input reads its value. A
                              source mapping names conversation
                              (first_user_message, last_agent_message,
                              transcript, messages), scenario (situation,
                              criteria, or fields followed by a field
                              identifier) or trace (contexts, spans, or
                              tool_calls followed by a tool name and input or
                              output). A value mapping is a literal.
                          description: >-
                            Where each evaluator input reads its value, keyed by
                            input name. Inputs left out are unmapped; a required
                            input left unmapped refuses the run.
                      required:
                        - id
                        - evaluatorId
                        - required
                        - mappings
                      additionalProperties: false
                      description: >-
                        One evaluator that runs after every scenario run, with
                        where each of its inputs reads from.
                  archivedAt:
                    description: When the suite was archived, or null while it is active.
                    type:
                      - string
                      - 'null'
                  createdAt:
                    type: string
                    description: When the suite was created.
                  updatedAt:
                    type: string
                    description: When the suite was last written.
                  platformUrl:
                    type: string
                    format: uri
                    description: Where to open this test suite in the LangWatch platform.
                  scenarios:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The scenario id.
                        name:
                          type: string
                          description: The scenario name.
                      required:
                        - id
                        - name
                      additionalProperties: false
                    description: >-
                      The active scenarios filed in this suite. An archived
                      scenario is left out.
                required:
                  - id
                  - name
                  - slug
                  - scenarioIds
                  - scenarioCount
                  - archivedAt
                  - createdAt
                  - updatedAt
                  - platformUrl
                  - scenarios
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.