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_testSuites API

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

Vellum AI subpackage_testSuites API is one of 16 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.1.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.1.0
API Version
1.0.0
Base URL
https://api.vellum.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vellum AI subpackage_testSuites 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 ReplaceTestSuiteTestCaseRequest (5 properties), UpsertTestSuiteTestCaseRequest (5 properties), SearchResult (5 properties), ChatMessage (5 properties). Each schema is shown below with its type and property counts.

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

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 Default API
Vellum AI subpackage_deployments API
Vellum AI subpackage_documentIndexes API
Vellum AI subpackage_documents API
Vellum AI subpackage_events API
Vellum AI subpackage_folderEntities API
Vellum AI subpackage_sandboxes API
Vellum AI subpackage_testSuiteRuns API
Vellum AI subpackage_uploadedFiles API
Vellum AI subpackage_workflowDeployments API
Vellum AI subpackage_workflowExecutions API
Where this information came from

This is an independent, third-party profile of Vellum AI subpackage_testSuites 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.