How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vellum AI Default API

The Default API from Vellum AI — 8 operation(s) for default.

Vellum AI Default 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 8 paths, and defines 312 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.

8 operations 8 paths 312 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.vellum.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vellum AI Default API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (default).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 8
POST
/v1/execute-prompt
Execute Prompt
execute-prompt 2 params body → 200400403404500
POST
/v1/execute-prompt-stream
Execute Prompt Stream
execute-prompt-stream 2 params body → 200400403404500
POST
/v1/submit-completion-actuals
Submit Completion Actuals
submit-completion-actuals 2 params body → 200400404500
POST
/v1/execute-workflow
Execute Workflow
execute-workflow 2 params body → 200400404500
POST
/v1/execute-workflow-async
Execute Workflow Async
execute-workflow-async 2 params body → 200400404500
POST
/v1/execute-workflow-stream
Execute Workflow Stream
execute-workflow-stream 2 params body → 200400404500
POST
/v1/submit-workflow-execution-actuals
Submit Workflow Execution Actuals
submit-workflow-execution-actuals 2 params body → 200
POST
/v1/search
Search
search 2 params body → 200400404500

Schemas 312

The contract defines 312 schemas that model the data the API accepts and returns. The most detailed are FulfilledWorkflowNodeResultEvent (9 properties), ExecuteWorkflowStreamRequest (9 properties), StreamingWorkflowNodeResultEvent (9 properties), ExecutePromptRequest (9 properties). Each schema is shown below with its type and property counts.

ErrorVellumValue
object
A value representing an Error.
2 properties 2 required
TemplatingNodeSearchResultsResult
object
3 properties 3 required
ArrayVellumValue
object
A value representing an array of Vellum variable values.
2 properties 2 required
WorkflowOutput
ExecutePromptEvent
WorkflowOutputChatHistory
object
A chat history output from a Workflow execution.
4 properties 4 required
WorkflowRequestNumberInputRequest
object
The input for a number variable in a Workflow.
3 properties 3 required
MetricEnum
string
NodeOutputCompiledValue
CodeExecutionNodeSearchResultsResult
object
3 properties 3 required
DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
2 properties 2 required
SearchRequestOptionsRequest
object
4 properties
SearchFiltersRequest
object
2 properties
CodeExecutionNodeNumberResult
object
3 properties 3 required
NodeEnum
string
FunctionCallVellumValueRequest
object
A value representing a Function Call.
2 properties 2 required
TemplatingNodeResultOutput
StreamingEnum
string
CodeExecutionNodeResultData
object
2 properties 1 required
ChatHistoryVellumValueRequest
object
A value representing Chat History.
2 properties 2 required
StreamingPromptExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
1 property
NodeInputCompiledVideoValue
object
4 properties 4 required
WorkflowResultEventOutputData
ExecuteWorkflowAsyncResponse
object
The response from an async Workflow Deployment execution.
1 property 1 required
ExecutionFunctionCallVellumValue
object
A value representing a Function Call.
4 properties 4 required
NodeInputCompiledAudioValue
object
4 properties 4 required
ConditionalEnum
string
Price
object
2 properties 2 required
SubworkflowNodeResultData
object
1 property
CodeExecutionNodeArrayResult
object
3 properties 3 required
submit-workflow-execution-actuals_Response_200
object
Empty response body
RejectedPromptExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
2 properties
AudioEnum
string
InitiatedEnum
string
MergeNodeResultData
object
1 property
VellumError
object
3 properties 2 required
WorkflowEventErrorRawData
SubmitCompletionActualsErrorResponse
object
1 property 1 required
MetadataFilterRuleCombinator
string
and - AND or - OR
VellumVideoRequest
object
2 properties 1 required
ExecutionSearchResultsVellumValue
object
A value representing Search Results.
4 properties 4 required
RejectedEnum
string
SecretEnum
string
ThinkingEnum
string
PromptNodeExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
3 properties
WorkflowOutputError
object
An error output from a Workflow execution.
4 properties 4 required
MergeEnum
string
SearchResultMergingRequest
object
1 property
AudioVellumValueRequest
object
A base Vellum primitive value representing audio.
2 properties 2 required
FulfilledExecutePromptEvent
object
The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
5 properties 3 required
FunctionCallEnum
string
PromptNodeResult
object
A Node Result Event emitted from a Prompt Node.
2 properties 2 required
ExecutionThinkingVellumValue
object
A value representing Thinking mode output.
4 properties 4 required
TemplatingNodeChatHistoryResult
object
3 properties 3 required
TemplatingNodeNumberResult
object
3 properties 3 required
WorkflowEventError
object
4 properties 2 required
ExecutionJsonVellumValue
object
A value representing a JSON object.
4 properties 4 required
SearchResponse
object
1 property 1 required
LogicalOperator
string
= - EQUALS != - DOESNOTEQUAL - GREATERTHAN = - GREATERTHANOREQUALTO contains - CONTAINS beginsWith - BEGINSWITH endsWith - ENDSWITH doesNotContain - DOESNOTCON…
TemplatingNodeStringResult
object
3 properties 3 required
ExecutePromptResponse
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties 2 required
NodeInputCompiledErrorValue
object
4 properties 4 required
SubmitCompletionActualsRequest
object
3 properties 1 required
SearchResultDocument
object
4 properties 1 required
MLModelUsage
object
7 properties
CodeExecutionNodeResultOutput
WorkflowOutputSearchResults
object
A search results output from a Workflow execution.
4 properties 4 required
VellumValue
WorkflowNodeResultEvent
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties 2 required
CodeExecutionNodeErrorResult
object
3 properties 3 required
FunctionCallRequest
object
The final resolved function call value.
3 properties 2 required
NodeInputVariableCompiledValue
MapEnum
string
DocumentVellumValueRequest
object
A base Vellum primitive value representing a document.
2 properties 2 required
WorkflowOutputNumber
object
A number output from a Workflow execution.
4 properties 4 required
WorkflowOutputDocument
object
A document output from a Workflow execution.
4 properties 4 required
ChatHistoryVellumValue
object
A value representing Chat History.
2 properties 2 required
FulfilledWorkflowNodeResultEvent
object
An event that indicates that the node has fulfilled its execution.
9 properties 6 required
VideoInputRequest
object
A user input representing a Vellum Video value
3 properties 3 required
VideoEnum
string
SubmitWorkflowExecutionActualsRequest
object
3 properties 1 required
submit-completion-actuals_Response_200
object
Empty response body
ErrorVellumValueRequest
object
A value representing an Error.
2 properties 2 required
VideoChatMessageContent
object
A video value that is used in a chat message.
2 properties 2 required
ExecutionImageVellumValue
object
A base Vellum primitive value representing an image.
4 properties 4 required
WorkflowRequestJSONInputRequest
object
The input for a JSON variable in a Workflow.
3 properties 3 required
NodeOutputCompiledFunctionCallValue
object
An output returned by a node that is of type FUNCTIONCALL.
4 properties 3 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
NumberEnum
string
FulfilledEnum
string
WorkflowExecutionActualChatHistoryRequest
object
7 properties 1 required
WorkflowExecutionEventType
string
NODE - NODE WORKFLOW - WORKFLOW
WorkflowNodeResultEventState
string
INITIATED - INITIATED STREAMING - STREAMING FULFILLED - FULFILLED REJECTED - REJECTED
LogicalConditionEnum
string
SubmitCompletionActualRequest
object
6 properties
ImageVellumValueRequest
object
A base Vellum primitive value representing an image.
2 properties 2 required
RejectedExecuteWorkflowWorkflowResultEvent
object
The unsuccessful response from the Workflow execution containing an error specifying what went wrong.
4 properties 4 required
WorkflowRequestChatHistoryInputRequest
object
The input for a chat history variable in a Workflow.
3 properties 3 required
MetadataFilterRuleRequest
object
6 properties
ArrayVellumValueRequest
object
A value representing an array of Vellum variable values.
2 properties 2 required
ThinkingVellumValueRequest
object
A value representing Thinking mode output.
2 properties 2 required
FulfilledExecuteWorkflowWorkflowResultEvent
object
The successful response from the Workflow execution containing the produced outputs.
4 properties 4 required
ConditionCombinator
string
OR - OR AND - AND
WorkflowResultEventOutputDataArray
object
An Array output returned from a Workflow execution.
7 properties 5 required
NodeInputCompiledArrayValue
object
4 properties 4 required
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties 2 required
ImageEnum
string
VellumValueLogicalConditionGroupRequest
object
A higher-order condition that combines one or more basic conditions or other higher-order conditions.
4 properties 4 required
NodeOutputCompiledNumberValue
object
An output returned by a node that is of type NUMBER.
4 properties 3 required
IterationStateEnum
string
INITIATED - INITIATED FULFILLED - FULFILLED REJECTED - REJECTED
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties 2 required
PromptDeploymentExpandMetaRequest
object
7 properties
VellumValueLogicalExpressionRequest
NodeInputCompiledFunctionCallValue
object
4 properties 4 required
StreamingExecutePromptEvent
object
The data returned for each delta during the prompt execution stream.
6 properties 4 required
SearchResultRequest
object
5 properties 4 required
ExecutePromptStreamRequest
object
9 properties 1 required
SearchWeightsRequest
object
2 properties
TemplatingNodeJsonResult
object
3 properties 3 required
WorkflowOutputImage
object
An image output from a Workflow execution.
4 properties 4 required
SubworkflowNodeResult
object
A Node Result Event emitted from a Subworkflow Node.
2 properties 1 required
FulfilledPromptExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
4 properties
JsonEnum
string
ArrayEnum
string
TemplatingEnum
string
TemplatingNodeErrorResult
object
3 properties 3 required
WorkflowExecutionActualJsonRequest
object
7 properties 1 required
NodeOutputCompiledArrayValue
object
An output returned by a node that is of type ARRAY.
4 properties 3 required
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
ExecuteWorkflowErrorResponse
object
1 property 1 required
ErrorEnum
string
MetadataFiltersRequest
ExecutePromptRequest
object
9 properties 1 required
PdfSearchResultMetaSourceRequest
object
The source of a search result from a PDF document.
3 properties 3 required
WorkflowExpandMetaRequest
object
3 properties
RawPromptExecutionOverridesRequest
object
3 properties
ChatMessage
object
5 properties 1 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties 2 required
StreamingWorkflowNodeResultEvent
object
An event that indicates that the node has execution is in progress.
9 properties 5 required
DocumentEnum
string
LogicalConditionGroupEnum
string
SearchResult
object
5 properties 4 required
ApiNodeResultData
object
6 properties 4 required
JSONInputRequest
object
A user input representing a JSON object
3 properties 3 required
WorkflowRequestInputRequest
WorkflowRequestAudioInputRequest
object
The input for an audio variable in a Workflow.
3 properties 3 required
ThinkingVellumValue
object
A value representing Thinking mode output.
2 properties 2 required
VellumAudio
object
2 properties 1 required
SearchResultMetaSource
ConditionalNodeResult
object
A Node Result Event emitted from a Conditional Node.
2 properties 2 required
ExecuteWorkflowStreamErrorResponse
object
1 property 1 required
WorkflowRequestVideoInputRequest
object
The input for a video variable in a Workflow.
3 properties 3 required
TerminalNodeErrorResult
object
4 properties 3 required
WorkflowResultEvent
object
7 properties 4 required
ExecuteWorkflowWorkflowResultEvent
ExecutionArrayVellumValue
object
A value representing an array of Vellum variable values.
4 properties 4 required
PdfEnum
string
VideoVellumValueRequest
object
A base Vellum primitive value representing a video.
2 properties 2 required
NodeOutputCompiledJsonValue
object
An output returned by a node that is of type JSON.
4 properties 3 required
ExecuteWorkflowAsyncRequest
object
The request to execute a Workflow Deployment asynchronously.
7 properties 1 required
ConditionalNodeResultData
object
1 property
RejectedExecutePromptEvent
object
The final data returned indicating an error occurred during the stream.
4 properties 3 required
WorkflowExecutionWorkflowResultEvent
object
A WORKFLOW-level event emitted from the workflow's execution.
5 properties 3 required
NodeOutputCompiledErrorValue
object
An output returned by a node that is of type ERROR.
4 properties 3 required
TemplatingNodeArrayResult
object
3 properties 3 required
WorkflowNodeResultData
SearchResultMeta
object
1 property
SubmitWorkflowExecutionActualRequest
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
TerminalNodeArrayResult
object
4 properties 3 required
NodeOutputCompiledChatHistoryValue
object
An output returned by a node that is of type CHATHISTORY.
4 properties 3 required
StringInputRequest
object
A user input representing a string value
3 properties 3 required
InitiatedWorkflowNodeResultEvent
object
An event that indicates that the node has initiated its execution.
8 properties 5 required
ArrayChatMessageContentItemRequest
TerminalNodeStringResult
object
4 properties 3 required
WorkflowResultEventState
string
INITIATED - Initiated STREAMING - Streaming FULFILLED - Fulfilled REJECTED - Rejected PENDING - Pending
StringChatMessageContentRequest
object
A string value that is used in a chat message.
2 properties 2 required
VellumImage
object
2 properties 1 required
ExecutionErrorVellumValue
object
A value representing an Error.
4 properties 4 required
ExecutePromptApiErrorResponse
object
2 properties 1 required
VellumSecret
object
1 property 1 required
TerminalNodeChatHistoryResult
object
4 properties 3 required
VellumDocumentRequest
object
2 properties 1 required
PromptEnum
string
SubworkflowEnum
string
NodeInputCompiledChatHistoryValue
object
4 properties 4 required
NodeInputCompiledImageValue
object
4 properties 4 required
ChatHistoryInputRequest
object
A user input representing a list of chat messages
3 properties 3 required
TerminalNodeSearchResultsResult
object
4 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
WorkflowRequestStringInputRequest
object
The input for a string variable in a Workflow.
3 properties 3 required
ExecuteWorkflowResponse
object
4 properties 2 required
ExecutionStringVellumValue
object
A value representing a string.
4 properties 4 required
WorkflowStreamEvent
SearchEnum
string
WorkflowResultEventOutputDataFunctionCall
object
A Function Call output returned from a Workflow execution.
7 properties 5 required
StringChatMessageContent
object
A string value that is used in a chat message.
2 properties 2 required
InitiatedExecutePromptEvent
object
The initial data returned indicating that the response from the model has returned and begun streaming.
3 properties 2 required
PromptNodeResultData
object
6 properties 1 required
WorkflowExecutionEventErrorCode
string
WORKFLOWINITIALIZATION - WORKFLOWINITIALIZATION WORKFLOWCANCELLED - WORKFLOWCANCELLED WORKFLOWTIMEOUT - WORKFLOWTIMEOUT PROVIDERCREDENTIALSUNAVAILABLE - PROVID…
NodeInputCompiledStringValue
object
4 properties 4 required
ChatMessageContent
StringEnum
string
NumberVellumValue
object
A value representing a number.
2 properties 2 required
TerminalNodeNumberResult
object
4 properties 3 required
ExecutionDocumentVellumValue
object
A base Vellum primitive value representing a document.
4 properties 4 required
WorkflowResultEventOutputDataJSON
object
A JSON output streamed from a Workflow execution.
7 properties 5 required
AudioChatMessageContentRequest
object
An audio value that is used in a chat message.
2 properties 2 required
SearchResultsEnum
string
MetricNodeResult
object
A Node Result Event emitted from a Metric Node.
1 property 1 required
MapNodeResultData
object
2 properties 1 required
VellumAudioRequest
object
2 properties 1 required
JsonVellumValueRequest
object
A value representing a JSON object.
2 properties 2 required
WorkflowRequestImageInputRequest
object
The input for an image variable in a Workflow.
3 properties 3 required
WorkflowExecutionActualStringRequest
object
7 properties 1 required
WorkflowResultEventOutputDataSearchResults
object
A Search Results output streamed from a Workflow execution.
7 properties 5 required
TemplatingNodeResult
object
A Node Result Event emitted from a Templating Node.
2 properties 2 required
ExecutionChatHistoryVellumValue
object
A value representing Chat History.
4 properties 4 required
FinishReasonEnum
string
LENGTH - LENGTH STOP - STOP UNKNOWN - UNKNOWN
NodeInputCompiledSearchResultsValue
object
4 properties 4 required
CodeExecutionNodeStringResult
object
3 properties 3 required
WorkflowExecutionNodeResultEvent
object
A NODE-level event emitted from the workflow's execution.
5 properties 3 required
VellumImageRequest
object
2 properties 1 required
RejectedWorkflowNodeResultEvent
object
An event that indicates that the node has rejected its execution.
8 properties 6 required
FulfilledExecutePromptResponse
object
The successful response from the model containing all of the resolved values generated by the prompt.
6 properties 3 required
NodeOutputCompiledThinkingValue
object
An output returned by a node that is of type THINKING.
4 properties 3 required
WorkflowResultEventOutputDataString
object
A string output streamed from a Workflow execution.
7 properties 5 required
ExecuteWorkflowRequest
object
The request to invoke a Workflow Deployment execution.
8 properties 1 required
WorkflowOutputAudio
object
An audio output from a Workflow execution.
4 properties 4 required
StringVellumValueRequest
object
A value representing a string.
2 properties 2 required
ExecutionNumberVellumValue
object
A value representing a number.
4 properties 4 required
ApiNodeResult
object
A Node Result Event emitted from an API Node.
2 properties 2 required
MapNodeResult
object
A Node Result Event emitted from a Map Node.
2 properties 1 required
WorkflowOutputArray
object
An array output from a Workflow execution.
4 properties 4 required
WorkflowResultEventOutputDataError
object
An Error output streamed from a Workflow execution.
7 properties 5 required
SearchResultsVellumValue
object
A value representing Search Results.
2 properties 2 required
TerminalNodeResult
object
A Node Result Event emitted from a Terminal Node.
2 properties 2 required
CodeExecutionEnum
string
FunctionCallChatMessageContentValueRequest
object
The final resolved function call value.
3 properties 2 required
WorkflowOutputVideo
object
A video output from a Workflow execution.
4 properties 4 required
NodeOutputCompiledStringValue
object
An output returned by a node that is of type STRING.
4 properties 3 required
ExecutionVellumValue
ArrayChatMessageContent
object
A list of chat message content items.
2 properties 2 required
CodeExecutionNodeResult
object
A Node Result Event emitted from a Code Execution Node.
2 properties 2 required
SearchRequestBodyRequest
object
5 properties 1 required
SearchResultMetaRequest
object
1 property
ExecutionAudioVellumValue
object
A base Vellum primitive value representing audio.
4 properties 4 required
WorkflowOutputJSON
object
A JSON output from a Workflow execution.
4 properties 4 required
SearchErrorResponse
object
1 property 1 required
StringVellumValue
object
A value representing a string.
2 properties 2 required
TemplatingNodeResultData
object
1 property 1 required
NodeOutputCompiledSearchResultsValue
object
An output returned by a node that is of type SEARCHRESULTS.
4 properties 3 required
TerminalEnum
string
MergeNodeResult
object
A Node Result Event emitted from a Merge Node.
2 properties 2 required
NodeInputCompiledNumberValue
object
4 properties 4 required
WorkflowEnum
string
MetadataFilterConfigRequest
object
A deprecated pattern for filtering on metadata. Please use MetadataFilters instead.
6 properties
RejectedExecutePromptResponse
object
The unsuccessful response from the model containing an error of what went wrong.
5 properties 3 required
ExecutionVideoVellumValue
object
A base Vellum primitive value representing a video.
4 properties 4 required
TerminalNodeResultOutput
WorkflowOutputString
object
A string output from a Workflow execution.
4 properties 4 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
NodeInputCompiledSecretValue
object
4 properties 4 required
WorkflowOutputFunctionCall
object
A function call output from a Workflow execution.
4 properties 4 required
VellumValueLogicalConditionRequest
object
A basic condition comparing two Vellum values.
4 properties 4 required
DocumentChatMessageContent
object
A document value that is used in a chat message.
2 properties 2 required
ApiEnum
string
FunctionCallChatMessageContentRequest
object
A function call 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
WorkflowRequestDocumentInputRequest
object
The input for a document variable in a Workflow.
3 properties 3 required
ImageInputRequest
object
A user input representing a Vellum Image value
3 properties 3 required
TerminalNodeResultData
object
1 property 1 required
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties 2 required
SearchResultsVellumValueRequest
object
A value representing Search Results.
2 properties 2 required
WorkflowResultEventOutputDataChatHistory
object
A Chat History output streamed from a Workflow execution.
7 properties 5 required
ImageVellumValue
object
A base Vellum primitive value representing an image.
2 properties 2 required
PromptOutput
SearchResultDocumentRequest
object
4 properties 1 required
TerminalNodeFunctionCallResult
object
4 properties 3 required
ExecuteWorkflowStreamRequest
object
The request to stream a Workflow Deployment execution.
9 properties 1 required
VellumValueRequest
VellumErrorRequest
object
3 properties 2 required
SearchNodeResultData
object
4 properties 3 required
VellumVideo
object
2 properties 1 required
TemplatingNodeFunctionCallResult
object
3 properties 3 required
ChatMessageRequest
object
5 properties 1 required
DocumentInputRequest
object
A user input representing a Vellum Document value
3 properties 3 required
NumberVellumValueRequest
object
A value representing a number.
2 properties 2 required
CodeExecutionNodeJsonResult
object
3 properties 3 required
NodeInputCompiledDocumentValue
object
4 properties 4 required
CodeExecutionNodeFunctionCallResult
object
3 properties 3 required
PromptExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
7 properties
ChatHistoryEnum
string
SearchNodeResult
object
A Node Result Event emitted from a Search Node.
2 properties 2 required
ImageChatMessageContent
object
An image value that is used in a chat message.
2 properties 2 required
TerminalNodeJsonResult
object
4 properties 3 required
ChatMessageContentRequest
WorkflowResultEventOutputDataNumber
object
A number output streamed from a Workflow execution.
7 properties 5 required
CodeExecutionNodeChatHistoryResult
object
3 properties 3 required
ArrayChatMessageContentItem
NodeInputCompiledJsonValue
object
4 properties 4 required
InitiatedPromptExecutionMeta
object
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with expandmeta.
4 properties
SearchResultMetaSourceRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vellum-default-api-openapi.yml Raw ↑

Other APIs Vellum AI publishes across the network.

Vellum LLM Platform 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_workflowDeployments API
Vellum AI subpackage_workflowExecutions API
Where this information came from

This is an independent, third-party profile of Vellum AI Default 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.