Vellum AI Execute Workflow 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 Execute Workflow. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
1 operation
across 1 path,
and defines 101 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.
The identity and technical contract details declared by the specification.
VellumVideo
object
2 properties
1 required
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties
2 required
StringVellumValue
object
A value representing a string.
2 properties
2 required
WorkflowRequestImageInputRequest
object
The input for an image variable in a Workflow.
3 properties
3 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
ArrayVellumValue
object
A value representing an array of Vellum variable values.
2 properties
2 required
WorkflowRequestAudioInputRequest
object
The input for an audio variable in a Workflow.
3 properties
3 required
WorkflowExpandMetaRequest
object
3 properties
ArrayChatMessageContentItemRequest
JsonVellumValue
object
A value representing a JSON object.
2 properties
2 required
ExecuteWorkflowResponse
object
4 properties
2 required
VellumVideoRequest
object
2 properties
1 required
SearchResult
object
5 properties
4 required
ErrorVellumValue
object
A value representing an Error.
2 properties
2 required
WorkflowRequestVideoInputRequest
object
The input for a video variable in a Workflow.
3 properties
3 required
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties
2 required
VellumDocumentRequest
object
2 properties
1 required
VellumImageRequest
object
2 properties
1 required
ChatMessageContentRequest
ChatMessageRequest
object
5 properties
1 required
WorkflowOutputDocument
object
A document output from a Workflow execution.
4 properties
4 required
NumberVellumValue
object
A value representing a number.
2 properties
2 required
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties
2 required
ArrayChatMessageContentItem
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
VideoVellumValue
object
A base Vellum primitive value representing a video.
2 properties
2 required
FulfilledExecuteWorkflowWorkflowResultEvent
object
The successful response from the Workflow execution containing the produced outputs.
4 properties
4 required
StringChatMessageContentRequest
object
A string value that is used in a chat message.
2 properties
2 required
ChatMessage
object
5 properties
1 required
WorkflowOutputChatHistory
object
A chat history output from a Workflow execution.
4 properties
4 required
AudioVellumValue
object
A base Vellum primitive value representing audio.
2 properties
2 required
ExecuteWorkflowErrorResponse
object
1 property
1 required
WorkflowRequestJSONInputRequest
object
The input for a JSON variable in a Workflow.
3 properties
3 required
RejectedExecuteWorkflowWorkflowResultEvent
object
The unsuccessful response from the Workflow execution containing an error specifying what went wrong.
4 properties
4 required
PdfSearchResultMetaSource
object
The source of a search result from a PDF document.
3 properties
3 required
ExecuteWorkflowWorkflowResultEvent
WorkflowExecutionEventErrorCode
string
WORKFLOWINITIALIZATION - WORKFLOWINITIALIZATION WORKFLOWCANCELLED - WORKFLOWCANCELLED WORKFLOWTIMEOUT - WORKFLOWTIMEOUT PROVIDERCREDENTIALSUNAVAILABLE - PROVID…
ArrayChatMessageContent
object
A list of chat message content items.
2 properties
2 required
FunctionCallChatMessageContentValueRequest
object
The final resolved function call value.
3 properties
2 required
VellumAudio
object
2 properties
1 required
WorkflowOutputSearchResults
object
A search results output from a Workflow execution.
4 properties
4 required
WorkflowOutputFunctionCall
object
A function call output from a Workflow execution.
4 properties
4 required
WorkflowOutputArray
object
An array output from a Workflow execution.
4 properties
4 required
FunctionCall
object
The final resolved function call value.
3 properties
2 required
WorkflowRequestNumberInputRequest
object
The input for a number variable in a Workflow.
3 properties
3 required
WorkflowRequestChatHistoryInputRequest
object
The input for a chat history variable in a Workflow.
3 properties
3 required
WorkflowRequestDocumentInputRequest
object
The input for a document variable in a Workflow.
3 properties
3 required
WorkflowOutputError
object
An error output from a Workflow execution.
4 properties
4 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties
2 required
WorkflowEventError
object
4 properties
2 required
VellumAudioRequest
object
2 properties
1 required
SearchResultsVellumValue
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
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties
2 required
SearchResultMeta
object
1 property
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties
2 required
WorkflowRequestInputRequest
WorkflowOutputNumber
object
A number output from a Workflow execution.
4 properties
4 required
WorkflowOutputJSON
object
A JSON output from a Workflow execution.
4 properties
4 required
DocumentVellumValue
object
A base Vellum primitive value representing a document.
2 properties
2 required
VellumImage
object
2 properties
1 required
VellumDocument
object
2 properties
1 required
WorkflowRequestStringInputRequest
object
The input for a string variable in a Workflow.
3 properties
3 required
VellumError
object
3 properties
2 required
WorkflowEventErrorRawData
FunctionCallChatMessageContentRequest
object
A function call value that is used in a chat message.
2 properties
2 required
ThinkingVellumValue
object
A value representing Thinking mode output.
2 properties
2 required
VideoChatMessageContentRequest
object
A video value that is used in a chat message.
2 properties
2 required
WorkflowOutputAudio
object
An audio output from a Workflow execution.
4 properties
4 required
DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
2 properties
2 required
DocumentChatMessageContent
object
A document 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
ChatHistoryVellumValue
object
A value representing Chat History.
2 properties
2 required
StringChatMessageContent
object
A string 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
ExecuteWorkflowRequest
object
The request to invoke a Workflow Deployment execution.
8 properties
1 required
WorkflowOutputVideo
object
A video output from a Workflow execution.
4 properties
4 required
WorkflowOutputString
object
A string output from a Workflow execution.
4 properties
4 required
VideoChatMessageContent
object
A video value that is used in a chat message.
2 properties
2 required
SearchResultDocument
object
4 properties
1 required
WorkflowOutputImage
object
An image output from a Workflow execution.
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vellum AI publishes across the network.
