Vellum AI subpackage_workflowDeployments API
The subpackage_workflowDeployments API from Vellum AI — 10 operation(s) for subpackage_workflowdeployments.
Vellum AI subpackage_workflowDeployments 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_workflowDeployments. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 11 operations across 10 paths, and defines 206 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.
11 operations
10 paths
206 schemas
9 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Vellum AI subpackage_workflowDeployments API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-KEY (default).
Paths & Operations 11
Across 10 paths, the API surfaces 11 operations — 9 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_workflowDeployments 11
POST
/v1/workflow-deployments/{id}/execute-stream
Execute Stream
GET
/v1/workflow-deployments
List
GET
/v1/workflow-deployments/{id}/releases
List Workflow Deployment Releases
GET
/v1/workflow-deployments/{id}
Retrieve
GET
/v1/workflow-deployments/{id}/releases/{release_id_or_release_tag}
Retrieve Workflow Deployment Release
GET
/v1/workflow-deployments/{id}/release-tags/{name}
Retrieve Workflow Release Tag
PATCH
/v1/workflow-deployments/{id}/release-tags/{name}
Update Workflow Release Tag
GET
/v1/workflow-deployments/{id}/release-tags
List Workflow Release Tags
GET
/v1/workflow-deployments/{id}/history/{history_id_or_release_tag}
Workflow Deployment History Item Retrieve
GET
/v1/workflow-deployments/{id}/execution-events
List Workflow Deployment Event Executions
GET
/v1/workflow-deployments/{id}/execution-events/{execution_id}
Workflow Deployment Event Execution
Schemas 206
The contract defines 206 schemas that model the data the API accepts and returns. The most detailed are WorkflowDeploymentParentContext (12 properties), WorkflowDeploymentRead (12 properties), PromptDeploymentParentContext (12 properties), WorkflowEventExecutionRead (12 properties). Each schema is shown below with its type and property counts.
WorkflowNodeEnum
string
ErrorVellumValue
object
A value representing an Error.
2 properties
2 required
PdfEnum
string
EntityStatus
string
ACTIVE - Active ARCHIVED - Archived PENDINGDELETION - Pending Deletion
workflow.execution.snapshottedEnum
string
ReleaseReviewReviewer
object
2 properties
1 required
SearchResultsVellumValue
object
A value representing Search Results.
2 properties
2 required
WorkflowModelProviderDependency
object
4 properties
3 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
WorkflowExecutionActual
object
4 properties
3 required
VellumVariableType
string
STRING - STRING NUMBER - NUMBER JSON - JSON CHATHISTORY - CHATHISTORY SEARCHRESULTS - SEARCHRESULTS ERROR - ERROR ARRAY - ARRAY FUNCTIONCALL - FUNCTIONCALL AUD…
NodeParentContext
object
5 properties
3 required
ModelProviderEnum
string
PatchedWorkflowReleaseTagUpdateRequest
object
1 property
IntegrationEnum
string
WorkflowDeploymentReleaseWorkflowDeployment
object
2 properties
2 required
WorkflowIntegrationDependency
object
4 properties
3 required
WorkflowExecutionUsageCalculationError
object
2 properties
2 required
VellumSpan
workflow.execution.rejectedEnum
string
VideoEnum
string
NodeExecutionFulfilledBody
object
5 properties
2 required
PaginatedWorkflowReleaseTagReadList
object
4 properties
VideoChatMessageContent
object
A video value that is used in a chat message.
2 properties
2 required
UpdateActiveWorkspaceResponse
object
3 properties
2 required
ExecutionImageVellumValue
object
A base Vellum primitive value representing an image.
4 properties
4 required
WorkflowExecutionSnapshottedBody
object
3 properties
2 required
SlimWorkflowDeployment
object
A subset of a Workflow Deployment's full details.
10 properties
7 required
SearchResultMeta
object
1 property
ReleaseReviewState
string
APPROVED - Approved CHANGESREQUESTED - Changes Requested COMMENTED - Commented
AudioVellumValue
object
A base Vellum primitive value representing audio.
2 properties
2 required
node.executionEnum
string
VellumSdkErrorCodeEnum
string
INVALIDWORKFLOW - INVALIDWORKFLOW INVALIDINPUTS - INVALIDINPUTS INVALIDOUTPUTS - INVALIDOUTPUTS INVALIDSTATE - INVALIDSTATE INVALIDCODE - INVALIDCODE INVALIDTE…
ExecutionVellumValue
WorkflowInitializationError
object
Workflow initialization error.
2 properties
2 required
ArrayChatMessageContent
object
A list of chat message content items.
2 properties
2 required
workflow.execution.resumedEnum
string
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
node.execution.rejectedEnum
string
NodeExecutionResumedEvent
object
9 properties
6 required
WorkflowExecutionStreamingEvent
object
9 properties
6 required
NodeExecutionPausedEvent
object
9 properties
6 required
WorkflowExecutionViewOnlineEvalMetricResult
object
3 properties
3 required
node.execution.pausedEnum
string
NumberEnum
string
WorkflowDeploymentEventExecutionsResponse
object
2 properties
2 required
ExecuteWorkflowDeploymentStreamRequest
object
The request to execute a Workflow Deployment stream.
6 properties
ReleaseTagRelease
object
2 properties
2 required
ExecutionAudioVellumValue
object
A base Vellum primitive value representing audio.
4 properties
4 required
V1WorkflowDeploymentsIdReleaseTagsGetParametersSource
string
WorkflowDependency
node.execution.resumedEnum
string
WorkflowExecutionUsageCalculationErrorCodeEnum
string
UNKNOWN - UNKNOWN DEPENDENCIESFAILED - DEPENDENCIESFAILED NOUSAGECALCULATED - NOUSAGECALCULATED INTERNALSERVERERROR - INTERNALSERVERERROR
NodeExecutionPausedBody
object
1 property
1 required
WorkflowExecutionSpan
object
8 properties
7 required
VellumImage
object
2 properties
1 required
WorkflowExecutionFulfilledEvent
object
9 properties
6 required
IntegrationTriggerContext
object
5 properties
2 required
SpanLink
object
3 properties
3 required
StringVellumValue
object
A value representing a string.
2 properties
2 required
ExecutionErrorVellumValue
object
A value representing an Error.
4 properties
4 required
VellumCodeResourceDefinition
object
4 properties
3 required
SlimReleaseReview
object
4 properties
4 required
BaseOutput
object
3 properties
1 required
WorkflowExecutionPausedBody
object
2 properties
2 required
NodeExecutionFulfilledEvent
object
9 properties
6 required
WorkflowExecutionResumedBody
object
1 property
1 required
NodeExecutionLogEvent
object
9 properties
6 required
WorkflowError
node.execution.logEnum
string
WorkflowExecutionRejectedEvent
object
9 properties
6 required
ExecutionFunctionCallVellumValue
object
A value representing a Function Call.
4 properties
4 required
workflow.execution.streamingEnum
string
WorkflowEnum
string
MLModelUsageWrapper
object
2 properties
2 required
VellumDocument
object
2 properties
1 required
Price
object
2 properties
2 required
node.execution.fulfilledEnum
string
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
ExecutionVideoVellumValue
object
A base Vellum primitive value representing a video.
4 properties
4 required
WorkflowEventExecutionRead
object
12 properties
11 required
WorkflowDeploymentReleaseWorkflowVersion
object
The workflow version associated with a workflow deployment release.
4 properties
3 required
ScheduledEnum
string
workflow.execution.pausedEnum
string
PaginatedSlimWorkflowDeploymentList
object
4 properties
SpanLinkTypeEnum
string
TRIGGEREDBY - TRIGGEREDBY PREVIOUSSPAN - PREVIOUSSPAN ROOTSPAN - ROOTSPAN
NodeExecutionInitiatedEvent
object
9 properties
6 required
WorkflowExecutionFulfilledBody
object
5 properties
2 required
ExecutionStringVellumValue
object
A value representing a string.
4 properties
4 required
VellumVariableExtensions
object
A set of fields with additional properties for use in Vellum Variables.
3 properties
AudioEnum
string
ExternalParentContext
object
4 properties
2 required
ImageEnum
string
NodeExecutionLogBody
object
4 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
EnvironmentEnum
string
ReleaseReleaseTag
object
2 properties
2 required
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties
2 required
ExternalInputDescriptor
object
4 properties
2 required
node.execution.initiatedEnum
string
DocumentChatMessageContent
object
A document value that is used in a chat message.
2 properties
2 required
WorkflowEventErrorRawData
WorkflowExecutionEventErrorCode
string
WORKFLOWINITIALIZATION - WORKFLOWINITIALIZATION WORKFLOWCANCELLED - WORKFLOWCANCELLED WORKFLOWTIMEOUT - WORKFLOWTIMEOUT PROVIDERCREDENTIALSUNAVAILABLE - PROVID…
ReleaseEnvironment
object
3 properties
3 required
ChatMessageContent
UnitEnum
string
USD - USD
ParentContext
DocumentVellumValue
object
A base Vellum primitive value representing a document.
2 properties
2 required
StringEnum
string
NumberVellumValue
object
A value representing a number.
2 properties
2 required
APIRequestParentContext
object
7 properties
2 required
ExecutionSearchResultsVellumValue
object
A value representing Search Results.
4 properties
4 required
VellumSdkError
object
3 properties
2 required
InvokedPort
object
1 property
1 required
SeverityEnum
string
DEBUG - DEBUG INFO - INFO WARNING - WARNING ERROR - ERROR
ThinkingEnum
string
WorkflowReleaseTagRead
object
4 properties
4 required
ExecutionDocumentVellumValue
object
A base Vellum primitive value representing a document.
4 properties
4 required
V1WorkflowDeploymentsGetParametersStatus
string
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties
2 required
NodeExecutionInitiatedBody
object
2 properties
2 required
VellumVariable
object
7 properties
3 required
CodeResourceDefinition
object
The definition of a resource defined in code.
2 properties
2 required
WorkflowReleaseTagEnum
string
ImageVellumValue
object
A base Vellum primitive value representing an image.
2 properties
2 required
IntegrationName
string
SLACK - Slack NOTION - Notion GOOGLE - Google CALENDLY - Calendly CANVA - Canva CLICKUP - ClickUp CODA - Coda HUBSPOT - Hubspot INTERCOM - Intercom INSTAGRAM -…
JsonEnum
string
WorkflowExecutionUsageCalculationFulfilledBody
object
2 properties
2 required
VellumSdkErrorRawData
ApiVersionEnum
string
2024-10-25 - V20241025 2025-07-30 - V20250730
NodeExecutionStreamingBody
object
2 properties
2 required
WorkflowExecutionSnapshottedEvent
object
9 properties
6 required
NodeExecutionRejectedEvent
object
9 properties
6 required
ReleaseTagSource
string
SYSTEM - System USER - User
NodeExecutionSpan
object
8 properties
7 required
FunctionCallEnum
string
SearchResultsEnum
string
node.execution.streamingEnum
string
ArrayEnum
string
PaginatedWorkflowDeploymentReleaseList
object
4 properties
MLModelHostingInterface
string
ANTHROPIC - Anthropic AWSBEDROCK - AWS Bedrock AZUREAIFOUNDRY - Azure AI Foundry AZUREOPENAI - Azure OpenAI BASETEN - BaseTen CEREBRAS - Cerebras COHERE - Cohe…
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
WorkflowSandboxParentContext
object
7 properties
5 required
VellumVideo
object
2 properties
1 required
ErrorEnum
string
WorkflowParentContext
object
5 properties
3 required
ExecutionChatHistoryVellumValue
object
A value representing Chat History.
4 properties
4 required
WorkflowExecutionUsageResult
object
3 properties
ErrorDetailResponse
object
1 property
1 required
ExecutionThinkingVellumValue
object
A value representing Thinking mode output.
4 properties
4 required
VellumWorkflowExecutionEvent
ChatMessage
object
5 properties
1 required
ReleaseCreatedBy
object
3 properties
2 required
WorkflowDeploymentHistoryItem
object
8 properties
7 required
WorkflowEvent
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties
2 required
DocumentEnum
string
WorkflowDeploymentDisplayData
object
Workflow Deployment display data
1 property
NodeExecutionResumedBody
object
1 property
1 required
WorkflowExecutionRejectedBody
object
3 properties
2 required
WorkflowEventError
object
4 properties
2 required
ExecutionJsonVellumValue
object
A value representing a JSON object.
4 properties
4 required
workflow.execution.fulfilledEnum
string
WorkflowReleaseTagWorkflowDeploymentHistoryItem
object
2 properties
2 required
PromptReleaseTagEnum
string
NodeExecutionRejectedBody
object
3 properties
2 required
ChatHistoryEnum
string
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties
2 required
ApiRequestEnum
string
SlimWorkflowExecutionRead
object
10 properties
10 required
WorkflowExecutionInitiatedEvent
object
9 properties
6 required
ImageChatMessageContent
object
An image value that is used in a chat message.
2 properties
2 required
SearchResult
object
5 properties
4 required
ThinkingVellumValue
object
A value representing Thinking mode output.
2 properties
2 required
WorkflowDeploymentRelease
object
9 properties
8 required
VellumAudio
object
2 properties
1 required
SearchResultDocument
object
4 properties
1 required
WorkflowExecutionResumedEvent
object
9 properties
6 required
WorkflowSandboxEnum
string
SearchResultMetaSource
PromptDeploymentParentContext
object
12 properties
8 required
MLModelUsage
object
7 properties
WorkflowDeploymentRead
object
A Workflow Deployment's full details.
12 properties
8 required
WorkflowExecutionInitiatedBody
object
3 properties
2 required
workflow.execution.initiatedEnum
string
ExecutionNumberVellumValue
object
A value representing a number.
4 properties
4 required
ExternalEnum
string
WorkflowExecutionSpanAttributes
object
2 properties
2 required
VellumValue
NodeExecutionSpanAttributes
object
3 properties
2 required
ArrayChatMessageContentItem
ScheduledTriggerContext
object
5 properties
2 required
NodeExecutionStreamingEvent
object
9 properties
6 required
WorkflowExecutionStreamingBody
object
2 properties
2 required
workflow.executionEnum
string
WorkflowDisplayIcon
object
Icon to be used alongside a Workflow
2 properties
ExecutionArrayVellumValue
object
A value representing an array of Vellum variable values.
4 properties
4 required
WorkflowExecutionPausedEvent
object
9 properties
6 required
WorkflowDeploymentParentContext
object
12 properties
8 required
ApiActorTypeEnum
string
ANONYMOUS - ANONYMOUS WORKSPACEAPIKEY - WORKSPACEAPIKEY ENVIRONMENTAPIKEY - ENVIRONMENTAPIKEY JWT - JWT SERVICETOKEN - SERVICETOKEN
VellumNodeExecutionEvent
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Vellum AI 12
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_testSuites API
Vellum AI subpackage_uploadedFiles API
Vellum AI subpackage_workflowExecutions API
#subpackage_workflowDeployments
Where this information came from
This is an independent, third-party profile of Vellum AI subpackage_workflowDeployments 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.