Upsert Test Cases | Vellum

Upserts a new test case for a test suite, keying off of the optionally provided test case id. If an id is provided and has a match, the test case will be updated. If no id is provided or no match is found, a new test case will be appended to the end. Note that a full replacement of the test case is performed, so any fields not provided will be removed or overwritten with default values.

Path parameters

idstringRequired

Either the Test Suites' ID or its unique name

Request

This endpoint expects an object.

input_valueslist of objectsRequired

Values for each of the Test Case's input variables

evaluation_valueslist of objectsRequired

Values for each of the Test Case's evaluation variables

idstringOptionalformat: "uuid"

The Vellum-generated ID of an existing Test Case whose data you’d like to replace. If specified and no Test Case exists with this ID, a 404 will be returned.

external_idstringOptional>=1 character

An ID external to Vellum that uniquely identifies the Test Case that you’d like to create/update. If there’s a match on a Test Case that was previously created with the same external_id, it will be updated. Otherwise, a new Test Case will be created with this value as its external_id. If no external_id is specified, then a new Test Case will always be created.

labelstringOptional

A human-readable label used to convey the intention of this Test Case

Response

input_valueslist of objects

evaluation_valueslist of objects

idstring or null

external_idstring or null

labelstring or null

1	curl -X POST https://api.vellum.ai/v1/test-suites/id/test-cases \
2	-H "X-API-KEY: <X-API-KEY>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"input_values": [
6	{
7	"type": "STRING",
8	"value": "What are your favorite colors?",
9	"name": "var_1"
10	}
11	],
12	"evaluation_values": [
13	{
14	"type": "ARRAY",
15	"value": [
16	{
17	"type": "STRING",
18	"value": "Red"
19	},
20	{
21	"type": "STRING",
22	"value": "Green"
23	},
24	{
25	"type": "STRING",
26	"value": "Blue"
27	}
28	],
29	"name": "var_2"
30	}
31	],
32	"label": "Test Case 1"
33	}'

1	{
2	"input_values": [
3	{
4	"variable_id": "foo",
5	"name": "foo",
6	"type": "STRING",
7	"value": "foo"
8	}
9	],
10	"evaluation_values": [
11	{
12	"variable_id": "foo",
13	"name": "foo",
14	"type": "STRING",
15	"value": "foo"
16	}
17	],
18	"id": "foo",
19	"external_id": "foo",
20	"label": "foo"
21	}

Path parameters

Headers

Request

Response