Retrieve Test Suite Run

Beta

GET

Retrieve a specific Test Suite Run by ID

idstringRequired

A UUID string identifying this test suite run.

This endpoint returns an object.

idstring

createddatetime

test_suiteobject

stateenum

Allowed values: QUEUEDRUNNINGCOMPLETEFAILEDCANCELLED

The current state of this run

exec_configobjectOptional

Configuration that defines how the Test Suite should be run

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": "EXTERNAL",
12	"data": {
13	"executions": [
14	{
15	"outputs": [
16	{
17	"type": "ARRAY",
18	"name": "outputs"
19	}
20	],
21	"test_case_id": "test_case_id"
22	}
23	]
24	},
25	"test_case_ids": [
26	"exec_config"
27	]
28	}
29	}

1	curl https://api.vellum.ai/v1/test-suite-runs/id \
2	-H "X_API_KEY: <apiKey>"