How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vellum AI Subpackage Test Suites API

The subpackage_testSuites API from Vellum AI — 3 operation(s) for subpackage_testsuites.

Vellum AI Subpackage Test Suites API is one of 23 APIs that Vellum AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_testSuites. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 3 paths, and defines 142 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://predict.vellum.ai, https://api.vellum.ai, https://documents.vellum.ai.

4 operations 3 paths 142 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.vellum.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vellum AI Subpackage Test Suites API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (default).

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_testSuites 4
GET
/v1/test-suites/{id}/test-cases
List Test Suite Test Cases
list-test-suite-test-cases 5 params → 200
POST
/v1/test-suites/{id}/test-cases
Upsert Test Suite Test Case
upsert-test-suite-test-case 3 params body → 200
POST
/v1/test-suites/{id}/test-cases-bulk
Test Suite Test Cases Bulk
test-suite-test-cases-bulk 3 params body → 200
DELETE
/v1/test-suites/{id}/test-cases/{test_case_id}
Delete Test Suite Test Case
delete-test-suite-test-case 4 params → 204

Schemas 142

The contract defines 142 schemas that model the data the API accepts and returns. The most detailed are ChatMessage (5 properties), UpsertTestSuiteTestCaseRequest (5 properties), SearchResult (5 properties), ReplaceTestSuiteTestCaseRequest (5 properties). Each schema is shown below with its type and property counts.

ImageVellumValueRequest
object
A base Vellum primitive value representing an image.
2 properties 2 required
TestCaseErrorVariableValue
object
An error value for a variable in a Test Case.
4 properties 4 required
NamedTestCaseDocumentVariableValueRequest
object
3 properties 3 required
DocumentChatMessageContent
object
A document value that is used in a chat message.
2 properties 2 required
ArrayChatMessageContent
object
A list of chat message content items.
2 properties 2 required
ChatHistoryVellumValue
object
A value representing Chat History.
2 properties 2 required
VideoChatMessageContentRequest
object
A video value that is used in a chat message.
2 properties 2 required
FunctionCallVellumValueRequest
object
A value representing a Function Call.
2 properties 2 required
PdfEnum
string
TestCaseVariableValue
AudioEnum
string
ImageChatMessageContent
object
An image value that is used in a chat message.
2 properties 2 required
VideoVellumValue
object
A base Vellum primitive value representing a video.
2 properties 2 required
CreateEnum
string
TestCaseStringVariableValue
object
A string value for a variable in a Test Case.
4 properties 4 required
SearchResultsEnum
string
VellumImage
object
2 properties 1 required
AudioChatMessageContentRequest
object
An audio value that is used in a chat message.
2 properties 2 required
TestSuiteTestCaseCreatedBulkResultData
object
Information about the Test Case that was created.
1 property 1 required
TestSuiteTestCase
object
5 properties 2 required
ErrorVellumValueRequest
object
A value representing an Error.
2 properties 2 required
StringChatMessageContentRequest
object
A string value that is used in a chat message.
2 properties 2 required
TestCaseAudioVariableValue
object
An audio value for a variable in a Test Case.
4 properties 4 required
VellumValueRequest
VellumError
object
3 properties 2 required
TestSuiteTestCaseBulkOperationRequest
FunctionCallRequest
object
The final resolved function call value.
3 properties 2 required
NamedTestCaseChatHistoryVariableValueRequest
object
Named Test Case value that is of type CHATHISTORY
3 properties 3 required
NamedTestCaseVariableValueRequest
ErrorVellumValue
object
A value representing an Error.
2 properties 2 required
TestSuiteTestCaseReplacedBulkResult
object
The result of a bulk operation that replaced a Test Case.
3 properties 3 required
ChatHistoryVellumValueRequest
object
A value representing Chat History.
2 properties 2 required
SearchResult
object
5 properties 4 required
ThinkingVellumValue
object
A value representing Thinking mode output.
2 properties 2 required
StringVellumValueRequest
object
A value representing a string.
2 properties 2 required
TestSuiteTestCaseDeletedBulkResult
object
The result of a bulk operation that deleted a Test Case.
3 properties 3 required
NumberEnum
string
TestSuiteTestCaseCreateBulkOperationRequest
object
A bulk operation that represents the creation of a Test Case.
3 properties 3 required
FunctionCallEnum
string
VellumValue
ArrayChatMessageContentItem
PdfSearchResultMetaSourceRequest
object
The source of a search result from a PDF document.
3 properties 3 required
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
SearchResultsVellumValue
object
A value representing Search Results.
2 properties 2 required
ArrayChatMessageContentItemRequest
DocumentVellumValueRequest
object
A base Vellum primitive value representing a document.
2 properties 2 required
TestSuiteTestCaseUpsertBulkOperationRequest
object
A bulk operation that represents the upserting of a Test Case.
3 properties 3 required
UpsertEnum
string
VellumVideo
object
2 properties 1 required
PdfSearchResultMetaSource
object
The source of a search result from a PDF document.
3 properties 3 required
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties 2 required
SearchResultDocumentRequest
object
4 properties 1 required
TestCaseFunctionCallVariableValue
object
A function call value for a variable in a Test Case.
4 properties 4 required
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties 2 required
VideoChatMessageContent
object
A video value that is used in a chat message.
2 properties 2 required
NamedTestCaseStringVariableValueRequest
object
Named Test Case value that is of type STRING
3 properties 3 required
VellumImageRequest
object
2 properties 1 required
TestSuiteTestCaseDeleteBulkOperationRequest
object
A bulk operation that represents the deletion of a Test Case.
3 properties 3 required
SearchResultDocument
object
4 properties 1 required
TestCaseJsonVariableValue
object
A JSON value for a variable in a Test Case.
4 properties 4 required
PaginatedTestSuiteTestCaseList
object
4 properties 4 required
NamedTestCaseAudioVariableValueRequest
object
Named Test Case value that is of type AUDIO
3 properties 3 required
TestCaseArrayVariableValue
object
An Array value for a variable in a Test Case.
4 properties 4 required
DocumentEnum
string
VideoVellumValueRequest
object
A base Vellum primitive value representing a video.
2 properties 2 required
ChatMessageContentRequest
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties 2 required
ChatMessageRequest
object
5 properties 1 required
ChatHistoryEnum
string
StringVellumValue
object
A value representing a string.
2 properties 2 required
TestCaseVideoVariableValue
object
A video value for a variable in a Test Case.
4 properties 4 required
RejectedEnum
string
ErrorEnum
string
NamedTestCaseFunctionCallVariableValueRequest
object
Named Test Case value that is of type FUNCTIONCALL
3 properties 3 required
TestSuiteTestCaseReplaceBulkOperationRequest
object
A bulk operation that represents the replacing of a Test Case.
3 properties 3 required
ReplacedEnum
string
TestSuiteTestCaseDeletedBulkResultData
object
Information about the Test Case that was deleted
1 property 1 required
FunctionCallChatMessageContentValueRequest
object
The final resolved function call value.
3 properties 2 required
SearchResultMetaSource
TestSuiteTestCaseDeleteBulkOperationDataRequest
object
1 property 1 required
SearchResultMetaRequest
object
1 property
ArrayEnum
string
FunctionCall
object
The final resolved function call value.
3 properties 2 required
DocumentVellumValue
object
A base Vellum primitive value representing a document.
2 properties 2 required
JsonVellumValue
object
A value representing a JSON object.
2 properties 2 required
TestSuiteTestCaseReplacedBulkResultData
object
Information about the Test Case that was replaced
1 property 1 required
StringEnum
string
NamedTestCaseImageVariableValueRequest
object
3 properties 3 required
NumberVellumValueRequest
object
A value representing a number.
2 properties 2 required
NamedTestCaseNumberVariableValueRequest
object
Named Test Case value that is of type NUMBER
3 properties 3 required
NamedTestCaseArrayVariableValueRequest
object
Named Test Case value that is of type ARRAY
3 properties 3 required
ArrayVellumValueRequest
object
A value representing an array of Vellum variable values.
2 properties 2 required
TestSuiteTestCaseRejectedBulkResult
object
The result of a bulk operation that failed to operate on a Test Case.
3 properties 2 required
NamedTestCaseSearchResultsVariableValueRequest
object
Named Test Case value that is of type SEARCHRESULTS
3 properties 3 required
VellumAudio
object
2 properties 1 required
TestSuiteTestCaseBulkResult
ImageEnum
string
VellumVideoRequest
object
2 properties 1 required
CreateTestSuiteTestCaseRequest
object
Information about the Test Case to create
4 properties 2 required
AudioVellumValueRequest
object
A base Vellum primitive value representing audio.
2 properties 2 required
DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
2 properties 2 required
ThinkingVellumValueRequest
object
A value representing Thinking mode output.
2 properties 2 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties 2 required
VellumDocument
object
2 properties 1 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
FunctionCallChatMessageContentRequest
object
A function call value that is used in a chat message.
2 properties 2 required
ChatMessageContent
NumberVellumValue
object
A value representing a number.
2 properties 2 required
JsonEnum
string
VideoEnum
string
ImageVellumValue
object
A base Vellum primitive value representing an image.
2 properties 2 required
TestCaseDocumentVariableValue
object
A document value for a variable in a Test Case.
4 properties 4 required
TestSuiteTestCaseCreatedBulkResult
object
The result of a bulk operation that created a Test Case.
3 properties 3 required
DeleteEnum
string
VellumDocumentRequest
object
2 properties 1 required
ChatMessage
object
5 properties 1 required
SearchResultMetaSourceRequest
DeletedEnum
string
SearchResultMeta
object
1 property
test-suites_delete_test_suite_test_case_Response_204
object
Empty response body
ReplaceTestSuiteTestCaseRequest
object
Information about the Test Case to replace
5 properties 2 required
NamedTestCaseVideoVariableValueRequest
object
3 properties 3 required
CreatedEnum
string
ReplaceEnum
string
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties 2 required
TestCaseImageVariableValue
object
An image value for a variable in a Test Case.
4 properties 4 required
TestCaseSearchResultsVariableValue
object
A search results value for a variable in a Test Case.
4 properties 4 required
NamedTestCaseErrorVariableValueRequest
object
Named Test Case value that is of type ERROR
3 properties 3 required
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties 2 required
VellumAudioRequest
object
2 properties 1 required
TestCaseNumberVariableValue
object
A numerical value for a variable in a Test Case.
4 properties 4 required
VellumErrorRequest
object
3 properties 2 required
UpsertTestSuiteTestCaseRequest
object
5 properties 2 required
TestCaseChatHistoryVariableValue
object
A chat history value for a variable in a Test Case.
4 properties 4 required
SearchResultsVellumValueRequest
object
A value representing Search Results.
2 properties 2 required
NamedTestCaseJsonVariableValueRequest
object
Named Test Case value that is of type JSON
3 properties 3 required
JsonVellumValueRequest
object
A value representing a JSON object.
2 properties 2 required
SearchResultRequest
object
5 properties 4 required
ArrayVellumValue
object
A value representing an array of Vellum variable values.
2 properties 2 required
AudioVellumValue
object
A base Vellum primitive value representing audio.
2 properties 2 required
ThinkingEnum
string
StringChatMessageContent
object
A string value that is used in a chat message.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vellum-subpackage-testsuites-api-openapi.yml Raw ↑

Other APIs Vellum AI publishes across the network.

Vellum LLM Platform API
Vellum AI Subpackage Deployments API
Vellum AI Subpackage Document Indexes API
Vellum AI Subpackage Documents API
Vellum AI Subpackage Events API
Vellum AI Subpackage Folder Entities API
Vellum AI Subpackage Sandboxes API
Vellum AI Subpackage Test Suite Runs API
Vellum AI Subpackage Uploaded Files API
Vellum AI Subpackage Workflow Deployments API
Vellum AI Subpackage Workflow Executions API
Vellum AI Subpackage Workflows API
Where this information came from

This is an independent, third-party profile of Vellum AI Subpackage Test Suites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.