Retrieve Test Suite Run | Vellum

Retrieve a specific Test Suite Run by ID

idstringRequired

A UUID string identifying this test suite run.

idstringformat: "uuid"

createddatetime

test_suiteobject

stateenum

The current state of this run

Allowed values:

exec_configobjectOptional

Configuration that defines how the Test Suite should be run

progressobjectOptional

1	{
2	"id": "id",
3	"created": "2024-01-15T09:30:00Z",
4	"test_suite": {
5	"id": "id",
6	"history_item_id": "history_item_id",
7	"label": "label"
8	},
9	"state": "QUEUED",
10	"exec_config": {
11	"type": "DEPLOYMENT_RELEASE_TAG",
12	"data": {
13	"deployment_id": "deployment_id",
14	"tag": "tag"
15	},
16	"test_case_ids": [
17	"test_case_ids"
18	]
19	},
20	"progress": {
21	"number_of_requested_test_cases": 1,
22	"number_of_completed_test_cases": 1
23	}
24	}

1	import { VellumClient } from "vellum-ai";
2
3	const client = new VellumClient({ apiKey: "YOUR_API_KEY" });
4	await client.testSuiteRuns.retrieve("id");