Test Suite Runs

Retrieve

Beta
GET
Retrieve a specific Test Suite Run by ID

Path parameters

idstringRequired
A UUID string identifying this test suite run.

Response

This endpoint returns an object
id
string
created
datetime
test_suite
object
state
enum

The current state of this run

  • QUEUED - Queued
  • RUNNING - Running
  • COMPLETE - Complete
  • FAILED - Failed
  • CANCELLED - Cancelled
Allowed values: QUEUEDRUNNINGCOMPLETEFAILEDCANCELLED
exec_config
unionOptional
Configuration that defines how the Test Suite should be run
GET
1curl https://api.vellum.ai/v1/test-suite-runs/id \
2     -H "X_API_KEY: <apiKey>"
200
Retrieved
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}
Built with