Get test by ID

Get a specific test by ID. See Tests.

GET /tests/{id}

Get test by ID

cURL

curl --request GET \
  --url https://api.galtea.ai/tests/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.galtea.ai/tests/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/tests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.galtea.ai/tests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galtea.ai/tests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.galtea.ai/tests/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/tests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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": "es-MX",
  "backgroundNoiseProfile": "street",
  "backgroundNoiseLevel": "medium",
  "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",
  "isExtendable": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

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

Response

200

application/json

Test retrieved 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, EXTENDING, CANCELLED

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

BCP-47 language tag (e.g. en, es-MX). The region subtag selects the regional variety in simulated user messages and voice synthesis; generated test text keeps the base language. The value is stored as the full tag.

Example:

"es-MX"

backgroundNoiseProfile · enum<string> | null

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.

Available options: office, street, car, white, pink

Example:

"street"

backgroundNoiseLevel · enum<string> | null

How loud the background noise is relative to the caller speech. Null means off; set together with backgroundNoiseProfile.

Available options: light, medium, heavy

Example:

"medium"

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

Example:

{ "key": "value" }

specificationId · string | null

Example:

"spec_123"

isExtendable · boolean

True when the test can be extended by re-running its original generator (generated tests; QUALITY only when it has a ground-truth document). False for uploaded tests.

Example:

true

createdAt · string<date-time>

deletedAt · string<date-time> | null