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

# Update test

> Apply a partial update to an existing test. See [Tests](https://docs.galtea.ai/concepts/product/test).

**Only `name` and `metadata` are mutable** post-creation. Attempting to update any
other field (`type`, `variants`, `strategies`, `uri`, `groundTruthUri`,
`dataCatalogUri`, `sourceTestId`, `maxTestCases`, etc.) returns a 400. Those are
fixed for the lifetime of the test because they drive generation, credit accounting,
and stored test-case shape.

To attach an existing test to a specification (or detach it), use
`specifications link-tests` / `specifications unlink-tests` — the test-specification
link is managed from the specification side, not by updating the test.




## OpenAPI

````yaml https://api.galtea.ai/openapi.json patch /tests/{id}
openapi: 3.0.0
info:
  version: 1.0.0
  title: Product Management Service API
  description: API documentation for Product Management Service
  contact:
    name: Galtea AI
servers:
  - url: https://api.galtea.ai
security:
  - bearerAuth: []
tags: []
externalDocs:
  description: Galtea Platform Documentation
  url: https://docs.galtea.ai
paths:
  /tests/{id}:
    patch:
      tags:
        - tests
      summary: Update test
      description: >
        Apply a partial update to an existing test. See
        [Tests](https://docs.galtea.ai/concepts/product/test).


        **Only `name` and `metadata` are mutable** post-creation. Attempting to
        update any

        other field (`type`, `variants`, `strategies`, `uri`, `groundTruthUri`,

        `dataCatalogUri`, `sourceTestId`, `maxTestCases`, etc.) returns a 400.
        Those are

        fixed for the lifetime of the test because they drive generation, credit
        accounting,

        and stored test-case shape.


        To attach an existing test to a specification (or detach it), use

        `specifications link-tests` / `specifications unlink-tests` — the
        test-specification

        link is managed from the specification side, not by updating the test.
      operationId: updateTest
      parameters:
        - name: id
          in: path
          description: Test ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        description: Fields to update. Only `name` and `metadata` are accepted.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestUpdateInput'
      responses:
        '200':
          description: Test updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Test'
        '400':
          description: >-
            Bad request — disallowed field in payload or invalid value for
            `name` / `metadata`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Test not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    TestUpdateInput:
      type: object
      additionalProperties: false
      description: >-
        Test update payload. Only `name` and `metadata` are mutable
        post-creation — any other field (type, variants, URIs, strategies, etc.)
        will be rejected with a 400.
      properties:
        name:
          type: string
          description: >-
            New test name. Must be a non-empty string; leading/trailing
            whitespace is trimmed.
          example: Quality Test (renamed)
        metadata:
          type: object
          nullable: true
          description: >-
            Arbitrary key-value metadata. Replaces the existing metadata object
            wholesale.
          example:
            key: value
    Test:
      type: object
      properties:
        id:
          type: string
          example: test_123
        productId:
          type: string
          nullable: true
          example: prod_123
        userId:
          type: string
          nullable: true
          example: user_123
        name:
          type: string
          example: Quality Test
        type:
          type: string
          enum:
            - QUALITY
            - RED_TEAMING
            - SCENARIOS
          example: QUALITY
        groundTruthUri:
          type: string
          nullable: true
          example: s3://my-bucket/tests/test_123/ground-truth.csv
          description: >-
            Canonical storage URI of the ground-truth file, derived from the
            presigned URL supplied at creation. S3: `s3://<bucket>/<key>`. Azure
            Blob: blob URL with the SAS query stripped (e.g.
            `https://<account>.blob.core.windows.net/<container>/<path>`).
        uri:
          type: string
          nullable: true
          example: s3://my-bucket/tests/test_123/test.csv
          description: >-
            Canonical storage URI of the uploaded custom test file. Same format
            rules as `groundTruthUri`.
        error:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - PENDING
            - SUCCESS
            - FAILED
            - AUGMENTING
          example: SUCCESS
        fewShot:
          type: string
          nullable: true
          example: Example few-shot learning data
          description: >-
            Optional few-shot examples (input/output pairs) used to guide
            test-case generation for QUALITY tests.
        languageCode:
          type: string
          nullable: true
          example: es-MX
          description: >-
            BCP-47 language tag (e.g. en, es-MX). The region subtag affects
            voice synthesis only.
        backgroundNoiseProfile:
          type: string
          nullable: true
          enum:
            - office
            - street
            - car
            - white
            - pink
          example: street
          description: >-
            Background noise mixed into the simulated caller audio during a
            voice test. Clip-backed (office, street, car) or synthetic (white,
            pink). Null means off; set together with backgroundNoiseLevel.
        backgroundNoiseLevel:
          type: string
          nullable: true
          enum:
            - light
            - medium
            - heavy
          example: medium
          description: >-
            How loud the background noise is relative to the caller speech. Null
            means off; set together with backgroundNoiseProfile.
        variants:
          type: array
          items:
            type: string
          example:
            - rag
            - summarization
          description: >-
            Test variants. QUALITY: rag, entity_extraction, summarization,
            classification, translation, correction, other. RED_TEAMING:
            data_leakage, financial_attacks, illegal_activities, misuse,
            toxicity, custom.
        customVariantDescription:
          type: string
          nullable: true
          example: Custom variant description
        strategies:
          type: array
          items:
            type: string
          example:
            - original
          description: >-
            Generation strategies. "original" is the default for RED_TEAMING. At
            least one strategy is required for SCENARIOS tests.
        customUserPersona:
          type: string
          nullable: true
          example: Business analyst
        maxTestCases:
          type: integer
          nullable: true
          example: 100
        models:
          type: array
          items:
            type: string
          example:
            - gpt-4
            - claude-3
        sourceTestId:
          type: string
          nullable: true
        dataCatalogUri:
          type: string
          nullable: true
          example: s3://my-bucket/tests/test_123/data-catalog.json
          description: >-
            Canonical storage URI of the data-catalog file (SCENARIOS tests
            only). Same format rules as `groundTruthUri`.
        metadata:
          type: object
          nullable: true
          example:
            key: value
        specificationId:
          type: string
          nullable: true
          example: spec_123
        createdAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          example: Error type
        message:
          type: string
          example: Error message description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authorization. Pass your API key in the Authorization header as
        a Bearer token. Both new (`gsk_*`) and legacy (`gsk-`) API keys are
        accepted, e.g. `Authorization: Bearer gsk_...` or `Authorization: Bearer
        gsk-...`.

````