Blog
Log In
Request Demo
Search...
/
Help Center
API Reference
Changelog
Overview
Getting started
Authentication
API Reference
Prompts
POST
Execute Prompt
STREAM
Execute Prompt as Stream
POST
Submit Prompt Execution Actuals
POST
Retrieve Provider Payload
Prompt Sandboxes
POST
Deploy Prompt Sandbox
POST
Upsert Prompt Sandbox Scenario
DEL
Delete Prompt Sandbox Scenario
Prompt Deployments
GET
List Prompt Deployments
GET
Retrieve Prompt Deployment
GET
Retrieve Prompt Deployment Release Tag
PATCH
Update Prompt Deployment Release Tag
Deprecated
POST
Generate Prompt
STREAM
Generate Prompt as Stream
Workflows
POST
Execute Workflow
STREAM
Execute Workflow as Stream
POST
Submit Workflow Execution Actuals
Workflow Sandboxes
POST
Deploy Workflow
Workflow Deployments
GET
List Workflow Deployments
GET
Retrieve Workflow Deployment
GET
Retrieve Workflow Deployment Release Tag
PATCH
Update Workflow Deployment Release Tag
Document Indexes
POST
Search
POST
Add Document
DEL
Remove Document
POST
Create Document Index
GET
Retrieve Document Index
GET
List Document Indexes
PATCH
Update Document Index
PUT
Replace Document Index
DEL
Delete Document Index
Documents
POST
Upload Document
GET
Retrieve Document
GET
List Documents
PATCH
Update Document
DEL
Delete Document
Test Suites
Test Cases
GET
List Test Cases
POST
Upsert Test Cases
STREAM
Bulk Update Test Cases
DEL
Delete Test Case
Test Suite Runs
POST
Create Test Suite Run
GET
Retrieve Test Suite Run
GET
List Test Suite Executions
Folder Entities
POST
Add Entity To Folder
Blog
Log In
Request Demo
Test Suites
Test Suite Runs
Create Test Suite Run
Beta
POST
https://
api.vellum.ai
/
v1
/
test-suite-runs
Trigger a Test Suite and create a new Test Suite Run
Request
Expand all
Collapse all
This endpoint expects an object.
test_suite_id
string
Required
The ID of the Test Suite to run
exec_config
union
Required
Configuration that defines how the Test Suite should be run
Show 3 variants
Response
Expand all
Collapse all
This endpoint returns an object
id
string
created
datetime
test_suite
object
Show 3 properties
state
enum
The current state of this run
QUEUED
- Queued
RUNNING
- Running
COMPLETE
- Complete
FAILED
- Failed
CANCELLED
- Cancelled
Allowed values:
QUEUED
RUNNING
COMPLETE
FAILED
CANCELLED
exec_config
union
Optional
Configuration that defines how the Test Suite should be run
Show 3 variants
Built with