The identity and technical contract details declared by the specification.
ErrorVellumValue
object
A value representing an Error.
2 properties
2 required
workflow.execution.snapshottedEnum
string
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
NodeParentContext
object
5 properties
3 required
ExecutionArrayVellumValue
object
A value representing an array of Vellum variable values.
4 properties
4 required
WorkflowExecutionUsageCalculationError
object
2 properties
2 required
workflow.execution.rejectedEnum
string
NodeExecutionFulfilledBody
object
5 properties
2 required
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
SearchResultMeta
object
1 property
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…
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
node.execution.rejectedEnum
string
NodeExecutionResumedEvent
object
9 properties
6 required
WorkflowExecutionStreamingEvent
object
9 properties
6 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
NodeExecutionPausedEvent
object
9 properties
6 required
node.execution.pausedEnum
string
ExecutionAudioVellumValue
object
A base Vellum primitive value representing audio.
4 properties
4 required
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
IntegrationTriggerContext
object
5 properties
2 required
SpanLink
object
3 properties
3 required
StringVellumValue
object
A value representing a string.
2 properties
2 required
VellumCodeResourceDefinition
object
4 properties
3 required
ExecutionErrorVellumValue
object
A value representing an Error.
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
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
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
workflow.execution.pausedEnum
string
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
ExternalParentContext
object
4 properties
2 required
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
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties
2 required
ExternalInputDescriptor
object
4 properties
2 required
node.execution.initiatedEnum
string
WorkflowExecutionEventErrorCode
string
WORKFLOWINITIALIZATION - WORKFLOWINITIALIZATION WORKFLOWCANCELLED - WORKFLOWCANCELLED WORKFLOWTIMEOUT - WORKFLOWTIMEOUT PROVIDERCREDENTIALSUNAVAILABLE - PROVID…
WorkflowEventErrorRawData
DocumentChatMessageContent
object
A document value that is used in a chat message.
2 properties
2 required
UnitEnum
string
USD - USD
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
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
ExecutionDocumentVellumValue
object
A base Vellum primitive value representing a document.
4 properties
4 required
WorkflowExecutionDetail
object
10 properties
9 required
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties
2 required
NodeExecutionInitiatedBody
object
2 properties
2 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
WorkflowExecutionUsageCalculationFulfilledBody
object
2 properties
2 required
NodeExecutionStreamingBody
object
2 properties
2 required
ApiVersionEnum
string
2024-10-25 - V20241025 2025-07-30 - V20250730
WorkflowExecutionSnapshottedEvent
object
9 properties
6 required
NodeExecutionRejectedEvent
object
9 properties
6 required
NodeExecutionSpan
object
8 properties
7 required
node.execution.streamingEnum
string
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
WorkflowSandboxParentContext
object
7 properties
5 required
VellumVideo
object
2 properties
1 required
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
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties
2 required
NodeExecutionResumedBody
object
1 property
1 required
WorkflowEventError
object
4 properties
2 required
WorkflowExecutionRejectedBody
object
3 properties
2 required
ExecutionJsonVellumValue
object
A value representing a JSON object.
4 properties
4 required
workflow.execution.fulfilledEnum
string
PromptReleaseTagEnum
string
NodeExecutionRejectedBody
object
3 properties
2 required
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties
2 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
VellumAudio
object
2 properties
1 required
WorkflowExecutionResumedEvent
object
9 properties
6 required
SearchResultDocument
object
4 properties
1 required
WorkflowSandboxEnum
string
MLModelUsage
object
7 properties
PromptDeploymentParentContext
object
12 properties
8 required
workflow.execution.initiatedEnum
string
WorkflowExecutionInitiatedBody
object
3 properties
2 required
WorkflowExecutionSpanAttributes
object
2 properties
2 required
ExecutionNumberVellumValue
object
A value representing a number.
4 properties
4 required
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
WorkflowExecutionFulfilledEvent
object
9 properties
6 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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vellum AI publishes across the network.
