Vellum AI subpackage_workflowExecutions API
The subpackage_workflowExecutions API from Vellum AI — 1 operation(s) for subpackage_workflowexecutions.
The subpackage_workflowExecutions API from Vellum AI — 1 operation(s) for subpackage_workflowexecutions.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vellum-subpackage-workflowexecutions-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Client SDK Subpackage Workflow Executions API
version: 1.0.0
servers:
- url: https://predict.vellum.ai
- url: https://api.vellum.ai
- url: https://documents.vellum.ai
tags:
- name: subpackage_workflowExecutions
paths:
/v1/workflow-executions/{execution_id}/detail:
get:
operationId: retrieve-workflow-execution-detail
summary: Retrieve Workflow Execution Detail
tags:
- subpackage_workflowExecutions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
format: uuid
- name: prev_span_id
in: query
description: Optional keyset cursor span_id to continue from (exclusive)
required: false
schema:
type: string
format: uuid
- name: span_limit
in: query
description: Maximum number of spans to return (for lazy loading)
required: false
schema:
type: integer
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: X-API-Version
in: header
required: false
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionDetail'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetailResponse'
'421':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActiveWorkspaceResponse'
components:
schemas:
node.execution.logEnum:
type: string
enum:
- node.execution.log
title: node.execution.logEnum
VellumErrorCodeEnum:
type: string
enum:
- INVALID_REQUEST
- INVALID_INPUTS
- PROVIDER_ERROR
- PROVIDER_CREDENTIALS_UNAVAILABLE
- INTEGRATION_CREDENTIALS_UNAVAILABLE
- REQUEST_TIMEOUT
- INTERNAL_SERVER_ERROR
- USER_DEFINED_ERROR
- WORKFLOW_CANCELLED
- NODE_CANCELLED
- PROVIDER_QUOTA_EXCEEDED
- CHAT_QUOTA_EXCEEDED
description: '* `INVALID_REQUEST` - INVALID_REQUEST
* `INVALID_INPUTS` - INVALID_INPUTS
* `PROVIDER_ERROR` - PROVIDER_ERROR
* `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE
* `INTEGRATION_CREDENTIALS_UNAVAILABLE` - INTEGRATION_CREDENTIALS_UNAVAILABLE
* `REQUEST_TIMEOUT` - REQUEST_TIMEOUT
* `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
* `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
* `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED
* `NODE_CANCELLED` - NODE_CANCELLED
* `PROVIDER_QUOTA_EXCEEDED` - PROVIDER_QUOTA_EXCEEDED
* `CHAT_QUOTA_EXCEEDED` - CHAT_QUOTA_EXCEEDED'
title: VellumErrorCodeEnum
ExecutionJsonVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/JsonEnum'
value:
oneOf:
- description: Any type
- type: 'null'
required:
- id
- name
- type
- value
description: A value representing a JSON object.
title: ExecutionJsonVellumValue
ChatMessage:
type: object
properties:
text:
type:
- string
- 'null'
role:
$ref: '#/components/schemas/ChatMessageRole'
content:
oneOf:
- $ref: '#/components/schemas/ChatMessageContent'
- type: 'null'
source:
type:
- string
- 'null'
description: An optional identifier representing who or what generated this message.
metadata:
type:
- object
- 'null'
additionalProperties:
description: Any type
required:
- role
title: ChatMessage
PdfEnum:
type: string
enum:
- PDF
title: PdfEnum
MLModelUsageWrapper:
type: object
properties:
ml_model_name:
type: string
ml_model_usage:
$ref: '#/components/schemas/MLModelUsage'
required:
- ml_model_name
- ml_model_usage
title: MLModelUsageWrapper
WorkflowNodeEnum:
type: string
enum:
- WORKFLOW_NODE
title: WorkflowNodeEnum
PromptDeploymentParentContext:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
type:
$ref: '#/components/schemas/PromptReleaseTagEnum'
span_id:
type: string
format: uuid
deployment_id:
type: string
format: uuid
deployment_name:
type: string
deployment_history_item_id:
type: string
format: uuid
release_tag_id:
type: string
format: uuid
release_tag_name:
type: string
external_id:
type:
- string
- 'null'
metadata:
type:
- object
- 'null'
additionalProperties:
description: Any type
prompt_version_id:
type: string
format: uuid
required:
- type
- span_id
- deployment_id
- deployment_name
- deployment_history_item_id
- release_tag_id
- release_tag_name
- prompt_version_id
title: PromptDeploymentParentContext
WorkflowExecutionPausedEvent:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
name:
$ref: '#/components/schemas/workflow.execution.pausedEnum'
body:
$ref: '#/components/schemas/WorkflowExecutionPausedBody'
id:
type: string
format: uuid
timestamp:
type: string
format: date-time
api_version:
$ref: '#/components/schemas/ApiVersionEnum'
trace_id:
type: string
format: uuid
span_id:
type: string
format: uuid
required:
- name
- body
- id
- timestamp
- trace_id
- span_id
title: WorkflowExecutionPausedEvent
SearchResultsEnum:
type: string
enum:
- SEARCH_RESULTS
title: SearchResultsEnum
ThinkingEnum:
type: string
enum:
- THINKING
title: ThinkingEnum
MLModelUsage:
type: object
properties:
output_token_count:
type:
- integer
- 'null'
input_token_count:
type:
- integer
- 'null'
input_char_count:
type:
- integer
- 'null'
output_char_count:
type:
- integer
- 'null'
compute_nanos:
type:
- integer
- 'null'
cache_creation_input_tokens:
type:
- integer
- 'null'
cache_read_input_tokens:
type:
- integer
- 'null'
title: MLModelUsage
ExecutionImageVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/ImageEnum'
value:
oneOf:
- $ref: '#/components/schemas/VellumImage'
- type: 'null'
required:
- id
- name
- type
- value
description: A base Vellum primitive value representing an image.
title: ExecutionImageVellumValue
node.execution.fulfilledEnum:
type: string
enum:
- node.execution.fulfilled
title: node.execution.fulfilledEnum
NodeExecutionInitiatedBody:
type: object
properties:
node_definition:
$ref: '#/components/schemas/VellumCodeResourceDefinition'
inputs:
type: object
additionalProperties:
description: Any type
required:
- node_definition
- inputs
title: NodeExecutionInitiatedBody
VideoEnum:
type: string
enum:
- VIDEO
title: VideoEnum
SpanLink:
type: object
properties:
trace_id:
type: string
format: uuid
type:
$ref: '#/components/schemas/SpanLinkTypeEnum'
span_context:
$ref: '#/components/schemas/ParentContext'
required:
- trace_id
- type
- span_context
title: SpanLink
VellumValue:
oneOf:
- $ref: '#/components/schemas/StringVellumValue'
- $ref: '#/components/schemas/NumberVellumValue'
- $ref: '#/components/schemas/JsonVellumValue'
- $ref: '#/components/schemas/AudioVellumValue'
- $ref: '#/components/schemas/VideoVellumValue'
- $ref: '#/components/schemas/ImageVellumValue'
- $ref: '#/components/schemas/DocumentVellumValue'
- $ref: '#/components/schemas/FunctionCallVellumValue'
- $ref: '#/components/schemas/ErrorVellumValue'
- $ref: '#/components/schemas/ArrayVellumValue'
- $ref: '#/components/schemas/ChatHistoryVellumValue'
- $ref: '#/components/schemas/SearchResultsVellumValue'
- $ref: '#/components/schemas/ThinkingVellumValue'
title: VellumValue
BaseOutput:
type: object
properties:
value:
oneOf:
- description: Any type
- type: 'null'
delta:
oneOf:
- description: Any type
- type: 'null'
name:
type: string
required:
- name
title: BaseOutput
VellumImage:
type: object
properties:
src:
type: string
description: "The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."
metadata:
type:
- object
- 'null'
additionalProperties:
description: Any type
required:
- src
title: VellumImage
VellumSdkErrorCodeEnum:
type: string
enum:
- INVALID_WORKFLOW
- INVALID_INPUTS
- INVALID_OUTPUTS
- INVALID_STATE
- INVALID_CODE
- INVALID_TEMPLATE
- INTERNAL_ERROR
- PROVIDER_CREDENTIALS_UNAVAILABLE
- INTEGRATION_CREDENTIALS_UNAVAILABLE
- PROVIDER_ERROR
- PROVIDER_QUOTA_EXCEEDED
- USER_DEFINED_ERROR
- WORKFLOW_CANCELLED
- WORKFLOW_TIMEOUT
- NODE_CANCELLED
- NODE_TIMEOUT
- NODE_EXECUTION
description: '* `INVALID_WORKFLOW` - INVALID_WORKFLOW
* `INVALID_INPUTS` - INVALID_INPUTS
* `INVALID_OUTPUTS` - INVALID_OUTPUTS
* `INVALID_STATE` - INVALID_STATE
* `INVALID_CODE` - INVALID_CODE
* `INVALID_TEMPLATE` - INVALID_TEMPLATE
* `INTERNAL_ERROR` - INTERNAL_ERROR
* `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE
* `INTEGRATION_CREDENTIALS_UNAVAILABLE` - INTEGRATION_CREDENTIALS_UNAVAILABLE
* `PROVIDER_ERROR` - PROVIDER_ERROR
* `PROVIDER_QUOTA_EXCEEDED` - PROVIDER_QUOTA_EXCEEDED
* `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
* `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED
* `WORKFLOW_TIMEOUT` - WORKFLOW_TIMEOUT
* `NODE_CANCELLED` - NODE_CANCELLED
* `NODE_TIMEOUT` - NODE_TIMEOUT
* `NODE_EXECUTION` - NODE_EXECUTION'
title: VellumSdkErrorCodeEnum
WorkflowExecutionResumedBody:
type: object
properties:
workflow_definition:
$ref: '#/components/schemas/VellumCodeResourceDefinition'
required:
- workflow_definition
title: WorkflowExecutionResumedBody
VellumSdkError:
type: object
properties:
message:
type: string
raw_data:
oneOf:
- $ref: '#/components/schemas/VellumSdkErrorRawData'
- type: 'null'
code:
$ref: '#/components/schemas/VellumSdkErrorCodeEnum'
required:
- message
- code
title: VellumSdkError
WorkflowExecutionUsageCalculationErrorCodeEnum:
type: string
enum:
- UNKNOWN
- DEPENDENCIES_FAILED
- NO_USAGE_CALCULATED
- INTERNAL_SERVER_ERROR
description: '* `UNKNOWN` - UNKNOWN
* `DEPENDENCIES_FAILED` - DEPENDENCIES_FAILED
* `NO_USAGE_CALCULATED` - NO_USAGE_CALCULATED
* `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR'
title: WorkflowExecutionUsageCalculationErrorCodeEnum
NodeExecutionInitiatedEvent:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
name:
$ref: '#/components/schemas/node.execution.initiatedEnum'
body:
$ref: '#/components/schemas/NodeExecutionInitiatedBody'
id:
type: string
format: uuid
timestamp:
type: string
format: date-time
api_version:
$ref: '#/components/schemas/ApiVersionEnum'
trace_id:
type: string
format: uuid
span_id:
type: string
format: uuid
required:
- name
- body
- id
- timestamp
- trace_id
- span_id
title: NodeExecutionInitiatedEvent
node.execution.resumedEnum:
type: string
enum:
- node.execution.resumed
title: node.execution.resumedEnum
VellumError:
type: object
properties:
code:
$ref: '#/components/schemas/VellumErrorCodeEnum'
message:
type: string
raw_data:
type:
- object
- 'null'
additionalProperties:
description: Any type
required:
- code
- message
title: VellumError
ErrorDetailResponse:
type: object
properties:
detail:
type: string
description: Message informing the user of the error.
required:
- detail
title: ErrorDetailResponse
ApiActorTypeEnum:
type: string
enum:
- ANONYMOUS
- WORKSPACE_API_KEY
- ENVIRONMENT_API_KEY
- JWT
- SERVICE_TOKEN
description: '* `ANONYMOUS` - ANONYMOUS
* `WORKSPACE_API_KEY` - WORKSPACE_API_KEY
* `ENVIRONMENT_API_KEY` - ENVIRONMENT_API_KEY
* `JWT` - JWT
* `SERVICE_TOKEN` - SERVICE_TOKEN'
title: ApiActorTypeEnum
ExecutionSearchResultsVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/SearchResultsEnum'
value:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SearchResult'
required:
- id
- name
- type
- value
description: A value representing Search Results.
title: ExecutionSearchResultsVellumValue
workflow.execution.rejectedEnum:
type: string
enum:
- workflow.execution.rejected
title: workflow.execution.rejectedEnum
DocumentVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/DocumentEnum'
value:
oneOf:
- $ref: '#/components/schemas/VellumDocument'
- type: 'null'
required:
- type
- value
description: A base Vellum primitive value representing a document.
title: DocumentVellumValue
ExecutionStringVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/StringEnum'
value:
type:
- string
- 'null'
required:
- id
- name
- type
- value
description: A value representing a string.
title: ExecutionStringVellumValue
SearchResultMetaSource:
oneOf:
- $ref: '#/components/schemas/PdfSearchResultMetaSource'
title: SearchResultMetaSource
ExecutionChatHistoryVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/ChatHistoryEnum'
value:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ChatMessage'
required:
- id
- name
- type
- value
description: A value representing Chat History.
title: ExecutionChatHistoryVellumValue
FunctionCallChatMessageContent:
type: object
properties:
type:
$ref: '#/components/schemas/FunctionCallEnum'
value:
$ref: '#/components/schemas/FunctionCallChatMessageContentValue'
required:
- type
- value
description: A function call value that is used in a chat message.
title: FunctionCallChatMessageContent
InvokedPort:
type: object
properties:
name:
type: string
required:
- name
title: InvokedPort
ExecutionArrayVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/ArrayEnum'
value:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VellumValue'
required:
- id
- name
- type
- value
description: A value representing an array of Vellum variable values.
title: ExecutionArrayVellumValue
ImageVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/ImageEnum'
value:
oneOf:
- $ref: '#/components/schemas/VellumImage'
- type: 'null'
required:
- type
- value
description: A base Vellum primitive value representing an image.
title: ImageVellumValue
WorkflowParentContext:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
workflow_definition:
$ref: '#/components/schemas/VellumCodeResourceDefinition'
type:
$ref: '#/components/schemas/WorkflowEnum'
span_id:
type: string
format: uuid
required:
- workflow_definition
- type
- span_id
title: WorkflowParentContext
WorkflowExecutionUsageResult:
type: object
properties:
usage:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/MLModelUsageWrapper'
cost:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Price'
error:
oneOf:
- $ref: '#/components/schemas/WorkflowExecutionUsageCalculationError'
- type: 'null'
title: WorkflowExecutionUsageResult
ExecutionVideoVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/VideoEnum'
value:
oneOf:
- $ref: '#/components/schemas/VellumVideo'
- type: 'null'
required:
- id
- name
- type
- value
description: A base Vellum primitive value representing a video.
title: ExecutionVideoVellumValue
PdfSearchResultMetaSource:
type: object
properties:
document_type:
$ref: '#/components/schemas/PdfEnum'
start_page_num:
type:
- integer
- 'null'
description: The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
end_page_num:
type:
- integer
- 'null'
description: The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
required:
- document_type
- start_page_num
- end_page_num
description: The source of a search result from a PDF document.
title: PdfSearchResultMetaSource
WorkflowExecutionFulfilledEvent:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
name:
$ref: '#/components/schemas/workflow.execution.fulfilledEnum'
body:
$ref: '#/components/schemas/WorkflowExecutionFulfilledBody'
id:
type: string
format: uuid
timestamp:
type: string
format: date-time
api_version:
$ref: '#/components/schemas/ApiVersionEnum'
trace_id:
type: string
format: uuid
span_id:
type: string
format: uuid
required:
- name
- body
- id
- timestamp
- trace_id
- span_id
title: WorkflowExecutionFulfilledEvent
ExecutionErrorVellumValue:
type: object
properties:
id:
type: string
description: The variable's uniquely identifying internal id.
name:
type: string
type:
$ref: '#/components/schemas/ErrorEnum'
value:
oneOf:
- $ref: '#/components/schemas/VellumError'
- type: 'null'
required:
- id
- name
- type
- value
description: A value representing an Error.
title: ExecutionErrorVellumValue
NumberVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/NumberEnum'
value:
type:
- number
- 'null'
format: double
required:
- type
- value
description: A value representing a number.
title: NumberVellumValue
ChatHistoryEnum:
type: string
enum:
- CHAT_HISTORY
title: ChatHistoryEnum
WorkflowExecutionInitiatedEvent:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
name:
$ref: '#/components/schemas/workflow.execution.initiatedEnum'
body:
$ref: '#/components/schemas/WorkflowExecutionInitiatedBody'
id:
type: string
format: uuid
timestamp:
type: string
format: date-time
api_version:
$ref: '#/components/schemas/ApiVersionEnum'
trace_id:
type: string
format: uuid
span_id:
type: string
format: uuid
required:
- name
- body
- id
- timestamp
- trace_id
- span_id
title: WorkflowExecutionInitiatedEvent
ImageEnum:
type: string
enum:
- IMAGE
title: ImageEnum
FunctionCallVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/FunctionCallEnum'
value:
oneOf:
- $ref: '#/components/schemas/FunctionCall'
- type: 'null'
required:
- type
- value
description: A value representing a Function Call.
title: FunctionCallVellumValue
ExternalParentContext:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
type:
$ref: '#/components/schemas/ExternalEnum'
span_id:
type: string
format: uuid
required:
- type
- span_id
title: ExternalParentContext
ExecutionVellumValue:
oneOf:
- $ref: '#/components/schemas/ExecutionStringVellumValue'
- $ref: '#/components/schemas/ExecutionNumberVellumValue'
- $ref: '#/components/schemas/ExecutionJsonVellumValue'
- $ref: '#/components/schemas/ExecutionChatHistoryVellumValue'
- $ref: '#/components/schemas/ExecutionSearchResultsVellumValue'
- $ref: '#/components/schemas/ExecutionErrorVellumValue'
- $ref: '#/components/schemas/ExecutionArrayVellumValue'
- $ref: '#/components/schemas/ExecutionFunctionCallVellumValue'
- $ref: '#/components/schemas/ExecutionThinkingVellumValue'
- $ref: '#/components/schemas/ExecutionAudioVellumValue'
- $ref: '#/components/schemas/ExecutionVideoVellumValue'
- $ref: '#/components/schemas/ExecutionImageVellumValue'
- $ref: '#/components/schemas/ExecutionDocumentVellumValue'
title: ExecutionVellumValue
CodeResourceDefinition:
type: object
properties:
name:
type: string
description: The name of the resource, typically a class name.
module:
type: array
items:
type: string
description: The module that this resource is defined in.
required:
- name
- module
description: The definition of a resource defined in code.
title: CodeResourceDefinition
APIRequestParentContext:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
type:
$ref: '#/components/schemas/ApiRequestEnum'
span_id:
type: string
format: uuid
api_actor_id:
type:
- string
- 'null'
api_actor_type:
oneOf:
- $ref: '#/components/schemas/ApiActorTypeEnum'
- type: 'null'
api_actor_label:
type:
- string
- 'null'
required:
- type
- span_id
title: APIRequestParentContext
VellumSdkErrorRawData:
oneOf:
- type: object
additionalProperties:
description: Any type
- type: string
title: VellumSdkErrorRawData
ArrayChatMessageContent:
type: object
properties:
type:
$ref: '#/components/schemas/ArrayEnum'
value:
type: array
items:
$ref: '#/components/schemas/ArrayChatMessageContentItem'
required:
- type
- value
description: A list of chat message content items.
title: ArrayChatMessageContent
VellumDocument:
type: object
properties:
src:
type: string
description: "The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."
metadata:
type:
- object
- 'null'
additionalProperties:
description: Any type
required:
- src
title: VellumDocument
AudioEnum:
type: string
enum:
- AUDIO
title: AudioEnum
ThinkingVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/ThinkingEnum'
value:
oneOf:
- $ref: '#/components/schemas/StringVellumValue'
- type: 'null'
required:
- type
- value
description: A value representing Thinking mode output.
title: ThinkingVellumValue
NodeExecutionLogBody:
type: object
properties:
node_definition:
$ref: '#/components/schemas/VellumCodeResourceDefinition'
message:
type: string
attributes:
type:
- object
- 'null'
additionalProperties:
description: Any type
severity:
$ref: '#/components/schemas/SeverityEnum'
required:
- node_definition
- message
- severity
title: NodeExecutionLogBody
FunctionCallEnum:
type: string
enum:
- FUNCTION_CALL
title: FunctionCallEnum
VellumNodeExecutionEvent:
oneOf:
- $ref: '#/components/schemas/NodeExecutionInitiatedEvent'
- $ref: '#/components/schemas/NodeExecutionStreamingEvent'
- $ref: '#/components/schemas/NodeExecutionFulfilledEvent'
- $ref: '#/components/schemas/NodeExecutionRejectedEvent'
- $ref: '#/components/schemas/NodeExecutionPausedEvent'
- $ref: '#/components/schemas/NodeExecutionResumedEvent'
- $ref: '#/components/schemas/NodeExecutionLogEvent'
title: VellumNodeExecutionEvent
workflow.execution.fulfilledEnum:
type: string
enum:
- workflow.execution.fulfilled
title: workflow.execution.fulfilledEnum
SearchResultsVellumValue:
type: object
properties:
type:
$ref: '#/components/schemas/SearchResultsEnum'
value:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SearchResult'
required:
- type
- value
description: A value representing Search Results.
title: SearchResultsVellumValue
NodeExecutionStreamingEvent:
type: object
properties:
parent:
oneOf:
- $ref: '#/components/schemas/ParentContext'
- type: 'null'
links:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SpanLink'
name:
$ref: '#/components/schemas/node.execution.streamingEnum'
body:
$ref: '#/components/schemas/NodeExecutionStreamingBody'
id:
type: string
format: uuid
timestamp:
type: string
format: date-time
api_version:
$ref: '#/components/schemas/ApiVersionEnum'
trace_id:
type: string
format: uuid
span
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vellum/refs/heads/main/openapi/vellum-subpackage-workflowexecutions-api-openapi.yml