For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Workflows SDK
    • Introduction
    • Installation
    • Core Concepts
    • Defining Control Flow
    • Configuration
    • Custom Docker Images
  • Client SDK
    • Introduction
    • Authentication
    • API Versioning
        • POSTCreate Test Suite Run
        • GETRetrieve Test Suite Run
        • GETList Test Suite Executions
LogoLogo
BlogLog InRequest Demo
Client SDKTest SuitesTest Suite Runs

Create Test Suite Run

Beta
POST
https://api.vellum.ai/v1/test-suite-runs
POST
/v1/test-suite-runs
1import requests
2
3url = "https://api.vellum.ai/v1/test-suite-runs"
4
5payload = { "exec_config": { "data": { "deployment_id": "string" } } }
6headers = {
7    "X-API-KEY": "<apiKey>",
8    "Content-Type": "application/json"
9}
10
11response = requests.post(url, json=payload, headers=headers)
12
13print(response.json())
201Created
1{
2  "id": "string",
3  "created": "2024-01-15T09:30:00Z",
4  "test_suite": {
5    "id": "string",
6    "history_item_id": "string",
7    "label": "string"
8  },
9  "state": "QUEUED",
10  "exec_config": {
11    "type": "DEPLOYMENT_RELEASE_TAG",
12    "data": {
13      "deployment_id": "string",
14      "tag": "LATEST"
15    },
16    "test_case_ids": [
17      "string"
18    ]
19  },
20  "progress": {
21    "number_of_requested_test_cases": 1,
22    "number_of_completed_test_cases": 1
23  }
24}
Trigger a Test Suite and create a new Test Suite Run
Was this page helpful?
Previous

Retrieve Test Suite Run

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
exec_configobjectRequired
Configuration that defines how the Test Suite should be run
test_suite_idstringOptionalformat: "uuid"

The ID of the Test Suite to run. Must provide either this or test_suite_id.

test_suite_namestringOptional>=1 character

The name of the Test Suite to run. Must provide either this or test_suite_id.

Response

idstringformat: "uuid"
createdstringformat: "date-time"
test_suiteobject
stateenum

The current state of this run

  • QUEUED - Queued
  • RUNNING - Running
  • COMPLETE - Complete
  • FAILED - Failed
  • CANCELLED - Cancelled
Allowed values:
exec_configobject or null
Configuration that defines how the Test Suite should be run
progressobject