Skip to main content
POST
/
v4
/
test-cases
Create a test case
curl --request POST \
  --url https://gentrace.ai/api/v4/test-cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "datasetId": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
  "name": "Prompting with a SQL query that does not return any results",
  "inputs": {
    "query": "What is the capital of France?"
  },
  "expectedOutputs": {
    "result": "No results found"
  }
}'
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z",
  "inputs": {
    "query": "What is the capital of France?"
  },
  "expectedOutputs": {
    "answer": "Paris"
  },
  "datasetId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Capital of France query",
  "pipelineId": "abcdef12-3456-7890-abcd-ef1234567890",
  "archivedAt": "2025-04-01T00:00:00.000Z",
  "deletedAt": "2025-04-01T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Enter Gentrace API key (Format: Authorization: Bearer <token>)

Body

application/json

Test case creation parameters

​
datasetId
string<uuid>
required

Dataset UUID

Example:

"b2c3d4e5-f6a7-8901-2345-67890abcdef1"

​
name
string
required

Test case name

Minimum length: 1
Example:

"Prompting with a SQL query that does not return any results"

​
inputs
object
required

Test case inputs as a JSON object

Example:
{ "query": "What is the capital of France?" }
​
expectedOutputs
object

Optional expected outputs as a JSON object

Example:
{ "result": "No results found" }

Response

Successful response

​
id
string<uuid>
required

Test Case UUID

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

​
createdAt
string
required

Creation timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

​
updatedAt
string
required

Last update timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

​
inputs
object
required

Input data for the test case

Example:
{ "query": "What is the capital of France?" }
​
expectedOutputs
object | null
required

Expected output data for the test case

Example:
{ "answer": "Paris" }
​
datasetId
string
required

Associated Dataset UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Test Case name

Example:

"Capital of France query"

​
pipelineId
string<uuid>
required

Associated Pipeline UUID

Example:

"abcdef12-3456-7890-abcd-ef1234567890"

​
archivedAt
string | null
required

Archive timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

​
deletedAt
string | null
required

Deletion timestamp (ISO 8601)

Example:

"2025-04-01T00:00:00.000Z"

⌘I