The identity and technical contract details declared by the specification.
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties
2 required
ErrorVellumValue
object
A value representing an Error.
2 properties
2 required
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
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
ArrayChatMessageContent
object
A list of chat message content items.
2 properties
2 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
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
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
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
NamedTestCaseArrayVariableValueRequest
object
Named Test Case value that is of type ARRAY
3 properties
3 required
VellumVideoRequest
object
2 properties
1 required
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
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
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
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
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
NamedTestCaseImageVariableValueRequest
object
3 properties
3 required
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
TestCaseArrayVariableValue
object
An Array value for a variable in a Test Case.
4 properties
4 required
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
UpsertTestSuiteTestCaseRequest
object
5 properties
2 required
ReplaceTestSuiteTestCaseRequest
object
Information about the Test Case to replace
5 properties
2 required
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
VellumImageRequest
object
2 properties
1 required
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
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
TestSuiteTestCaseBulkOperationRequest
test-suites_delete_test_suite_test_case_Response_204
object
Empty response body
NamedTestCaseVariableValueRequest
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vellum AI publishes across the network.