Vellum AI subpackage_deployments 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
8 operations
across 7 paths,
and defines 110 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
ErrorVellumValue
object
A value representing an Error.
2 properties
2 required
EntityStatus
string
ACTIVE - Active ARCHIVED - Archived PENDINGDELETION - Pending Deletion
ReleaseReviewReviewer
object
2 properties
1 required
PatchedDeploymentReleaseTagUpdateRequest
object
1 property
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…
CompilePromptMeta
object
The subset of the metadata tracked by Vellum during Prompt Deployment compilation that the request opted into with expandmeta.
3 properties
VideoInputRequest
object
A user input representing a Vellum Video value
3 properties
3 required
V1DeploymentsIdReleaseTagsGetParametersSource
string
DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
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
ReleaseReviewState
string
APPROVED - Approved CHANGESREQUESTED - Changes Requested COMMENTED - Commented
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
StringInputRequest
object
A user input representing a string value
3 properties
3 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
ReleaseTagRelease
object
2 properties
2 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
SlimReleaseReview
object
4 properties
4 required
ExecutePromptApiErrorResponse
object
2 properties
1 required
PromptDeploymentReleasePromptVersion
object
3 properties
3 required
DeploymentProviderPayloadResponse
object
2 properties
2 required
VellumDocumentRequest
object
2 properties
1 required
ChatHistoryInputRequest
object
A user input representing a list of chat messages
3 properties
3 required
VellumDocument
object
2 properties
1 required
PromptDeploymentInputRequest
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
AudioInputRequest
object
A user input representing a Vellum Audio value
3 properties
3 required
PromptDeploymentRelease
object
9 properties
8 required
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties
2 required
DeploymentProviderPayloadResponsePayload
VellumVariableExtensions
object
A set of fields with additional properties for use in Vellum Variables.
3 properties
DeploymentReleaseTagDeploymentHistoryItem
object
2 properties
2 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
ReleaseReleaseTag
object
2 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
PaginatedSlimDeploymentReadList
object
4 properties
ReleaseEnvironment
object
3 properties
3 required
CompilePromptDeploymentExpandMetaRequest
object
3 properties
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
ImageInputRequest
object
A user input representing a Vellum Image value
3 properties
3 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
V1DeploymentsGetParametersStatus
string
ReleaseTagSource
string
SYSTEM - System USER - User
VellumAudioRequest
object
2 properties
1 required
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
VellumVideo
object
2 properties
1 required
DeploymentHistoryItem
object
7 properties
6 required
ChatMessageRequest
object
5 properties
1 required
DocumentInputRequest
object
A user input representing a Vellum Document value
3 properties
3 required
ChatMessage
object
5 properties
1 required
ReleaseCreatedBy
object
3 properties
2 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties
2 required
DeploymentProviderPayloadRequest
object
5 properties
1 required
VellumImageRequest
object
2 properties
1 required
PromptDeploymentReleasePromptDeployment
object
2 properties
2 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
JSONInputRequest
object
A user input representing a JSON object
3 properties
3 required
PaginatedDeploymentReleaseTagReadList
object
4 properties
SlimDeploymentRead
object
A subset of a Prompt Deployment's full details.
9 properties
6 required
ChatMessageContentRequest
DeploymentReleaseTagRead
object
4 properties
4 required
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
PromptVersionBuildConfigSandbox
object
4 properties
4 required
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.
