Vellum AI subpackage_sandboxes API is one of 16 APIs that Vellum AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
3 operations
across 3 paths,
and defines 93 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.
The identity and technical contract details declared by the specification.
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties
2 required
ScenarioInputAudioVariableValue
object
3 properties
3 required
EntityStatus
string
ACTIVE - Active ARCHIVED - Archived PENDINGDELETION - Pending Deletion
ErrorVellumValue
object
A value representing an Error.
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
ArrayVellumValue
object
A value representing an array of Vellum variable values.
2 properties
2 required
VellumVariableType
string
STRING - STRING NUMBER - NUMBER JSON - JSON CHATHISTORY - CHATHISTORY SEARCHRESULTS - SEARCHRESULTS ERROR - ERROR ARRAY - ARRAY FUNCTIONCALL - FUNCTIONCALL AUD…
ScenarioInputVideoVariableValue
object
3 properties
3 required
NamedScenarioInputStringVariableValueRequest
object
Named Prompt Sandbox Scenario input value that is of type STRING
3 properties
3 required
DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
2 properties
2 required
ScenarioInputDocumentVariableValue
object
3 properties
3 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
NamedScenarioInputRequest
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
NamedScenarioInputChatHistoryVariableValueRequest
object
Named Prompt Sandbox Scenario input value that is of type CHATHISTORY
3 properties
3 required
ArrayChatMessageContentItemRequest
StringChatMessageContentRequest
object
A string value that is used in a chat message.
2 properties
2 required
VellumImage
object
2 properties
1 required
StringVellumValue
object
A value representing a string.
2 properties
2 required
sandboxes_delete_sandbox_scenario_Response_204
object
Empty response body
VellumDocumentRequest
object
2 properties
1 required
DeploySandboxPromptRequest
object
5 properties
UpsertSandboxScenarioRequest
object
3 properties
1 required
VellumDocument
object
2 properties
1 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
ScenarioInputStringVariableValue
object
Prompt Sandbox Scenario input value that is of type STRING
3 properties
3 required
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties
2 required
VellumVariableExtensions
object
A set of fields with additional properties for use in Vellum Variables.
3 properties
NamedScenarioInputJsonVariableValueRequest
object
Named Prompt Sandbox Scenario input value that is of type JSON
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
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
ScenarioInputChatHistoryVariableValue
object
Prompt Sandbox Scenario input value that is of type CHATHISTORY
3 properties
3 required
VellumVideoRequest
object
2 properties
1 required
DocumentVellumValue
object
A base Vellum primitive value representing a document.
2 properties
2 required
NumberVellumValue
object
A value representing a number.
2 properties
2 required
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties
2 required
VellumVariable
object
7 properties
3 required
AudioChatMessageContentRequest
object
An audio value that is used in a chat message.
2 properties
2 required
ImageVellumValue
object
A base Vellum primitive value representing an image.
2 properties
2 required
NamedScenarioInputVideoVariableValueRequest
object
3 properties
3 required
VellumAudioRequest
object
2 properties
1 required
SandboxScenario
object
Sandbox Scenario
3 properties
2 required
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
ScenarioInputImageVariableValue
object
3 properties
3 required
VellumVideo
object
2 properties
1 required
ChatMessageRequest
object
5 properties
1 required
ChatMessage
object
5 properties
1 required
ScenarioInputJsonVariableValue
object
Prompt Sandbox Scenario input value that is of type JSON
3 properties
3 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties
2 required
VellumImageRequest
object
2 properties
1 required
NamedScenarioInputDocumentVariableValueRequest
object
3 properties
3 required
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 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
NamedScenarioInputImageVariableValueRequest
object
3 properties
3 required
NamedScenarioInputAudioVariableValueRequest
object
3 properties
3 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
ArrayChatMessageContentItem
DeploymentRead
object
A Prompt Deployment's full details.
11 properties
8 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vellum AI publishes across the network.
