Skip to main content
PATCH
/
tests
/
{id}
Update test
curl --request PATCH \
  --url https://api.galtea.ai/tests/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Quality Test (renamed)",
  "metadata": {
    "key": "value"
  }
}
'
{
  "id": "test_123",
  "productId": "prod_123",
  "userId": "user_123",
  "name": "Quality Test",
  "type": "QUALITY",
  "groundTruthUri": "s3://my-bucket/tests/test_123/ground-truth.csv",
  "uri": "s3://my-bucket/tests/test_123/test.csv",
  "error": "<string>",
  "status": "SUCCESS",
  "fewShot": "Example few-shot learning data",
  "languageCode": "en",
  "variants": [
    "rag",
    "summarization"
  ],
  "customVariantDescription": "Custom variant description",
  "strategies": [
    "original"
  ],
  "customUserPersona": "Business analyst",
  "maxTestCases": 100,
  "models": [
    "gpt-4",
    "claude-3"
  ],
  "sourceTestId": "<string>",
  "dataCatalogUri": "s3://my-bucket/tests/test_123/data-catalog.json",
  "metadata": {
    "key": "value"
  },
  "specificationId": "spec_123",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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.

Authorizations

​
Authorization
string
header
required

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-....

Path Parameters

​
id
string
required

Test ID

Body

application/json

Fields to update. Only name and metadata are accepted.

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.

​
name
string

New test name. Must be a non-empty string; leading/trailing whitespace is trimmed.

Example:

"Quality Test (renamed)"

​
metadata
object

Arbitrary key-value metadata. Replaces the existing metadata object wholesale.

Example:
{ "key": "value" }

Response

Test updated successfully

​
id
string
Example:

"test_123"

​
productId
string | null
Example:

"prod_123"

​
userId
string | null
Example:

"user_123"

​
name
string
Example:

"Quality Test"

​
type
enum<string>
Available options:
QUALITY,
RED_TEAMING,
SCENARIOS
Example:

"QUALITY"

​
groundTruthUri
string | null

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>).

Example:

"s3://my-bucket/tests/test_123/ground-truth.csv"

​
uri
string | null

Canonical storage URI of the uploaded custom test file. Same format rules as groundTruthUri.

Example:

"s3://my-bucket/tests/test_123/test.csv"

​
error
string | null
​
status
enum<string>
Available options:
PENDING,
SUCCESS,
FAILED,
AUGMENTING
Example:

"SUCCESS"

​
fewShot
string | null

Optional few-shot examples (input/output pairs) used to guide test-case generation for QUALITY tests.

Example:

"Example few-shot learning data"

​
languageCode
string | null
Example:

"en"

​
variants
string[]

Test variants. QUALITY: rag, entity_extraction, summarization, classification, translation, correction, other. RED_TEAMING: data_leakage, financial_attacks, illegal_activities, misuse, toxicity, custom.

Example:
["rag", "summarization"]
​
customVariantDescription
string | null
Example:

"Custom variant description"

​
strategies
string[]

Generation strategies. "original" is the default for RED_TEAMING. At least one strategy is required for SCENARIOS tests.

Example:
["original"]
​
customUserPersona
string | null
Example:

"Business analyst"

​
maxTestCases
integer | null
Example:

100

​
models
string[]
Example:
["gpt-4", "claude-3"]
​
sourceTestId
string | null
​
dataCatalogUri
string | null

Canonical storage URI of the data-catalog file (SCENARIOS tests only). Same format rules as groundTruthUri.

Example:

"s3://my-bucket/tests/test_123/data-catalog.json"

​
metadata
object
Example:
{ "key": "value" }
​
specificationId
string | null
Example:

"spec_123"

​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null