Vellum AI subpackage_workflowExecutions API

The subpackage_workflowExecutions API from Vellum AI — 1 operation(s) for subpackage_workflowexecutions.

OpenAPI Specification

vellum-subpackage-workflowexecutions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Client SDK subpackage_workflowExecutions 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:
    WorkflowNodeEnum:
      type: string
      enum:
      - WORKFLOW_NODE
      title: WorkflowNodeEnum
    ErrorVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumError'
          - type: 'null'
      required:
      - type
      - value
      description: A value representing an Error.
      title: ErrorVellumValue
    PdfEnum:
      type: string
      enum:
      - PDF
      title: PdfEnum
    workflow.execution.snapshottedEnum:
      type: string
      enum:
      - workflow.execution.snapshotted
      title: workflow.execution.snapshottedEnum
    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
    ChatHistoryVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessage'
      required:
      - type
      - value
      description: A value representing Chat History.
      title: ChatHistoryVellumValue
    ArrayVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ArrayEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VellumValue'
      required:
      - type
      - value
      description: A value representing an array of Vellum variable values.
      title: ArrayVellumValue
    NodeParentContext:
      type: object
      properties:
        parent:
          oneOf:
          - $ref: '#/components/schemas/ParentContext'
          - type: 'null'
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SpanLink'
        node_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
        type:
          $ref: '#/components/schemas/WorkflowNodeEnum'
        span_id:
          type: string
          format: uuid
      required:
      - node_definition
      - type
      - span_id
      title: NodeParentContext
    IntegrationEnum:
      type: string
      enum:
      - INTEGRATION
      title: IntegrationEnum
    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
    WorkflowExecutionUsageCalculationError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/WorkflowExecutionUsageCalculationErrorCodeEnum'
        message:
          type: string
      required:
      - code
      - message
      title: WorkflowExecutionUsageCalculationError
    VellumSpan:
      oneOf:
      - $ref: '#/components/schemas/WorkflowExecutionSpan'
      - $ref: '#/components/schemas/NodeExecutionSpan'
      title: VellumSpan
    workflow.execution.rejectedEnum:
      type: string
      enum:
      - workflow.execution.rejected
      title: workflow.execution.rejectedEnum
    VideoEnum:
      type: string
      enum:
      - VIDEO
      title: VideoEnum
    NodeExecutionFulfilledBody:
      type: object
      properties:
        node_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
        invoked_ports:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvokedPort'
        outputs:
          type: object
          additionalProperties:
            description: Any type
        mocked:
          type:
          - boolean
          - 'null'
        redacted:
          type:
          - boolean
          - 'null'
      required:
      - node_definition
      - outputs
      title: NodeExecutionFulfilledBody
    VideoChatMessageContent:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VideoEnum'
        value:
          $ref: '#/components/schemas/VellumVideo'
      required:
      - type
      - value
      description: A video value that is used in a chat message.
      title: VideoChatMessageContent
    UpdateActiveWorkspaceResponse:
      type: object
      properties:
        update_active_workspace_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The id of the workspace that the user should update to, or null if no workspace change needed.
        update_active_environment_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The id of the environment that the user should update to, or null if no environment change needed.
        is_staff:
          type: boolean
          description: Whether or not the user is a staff member of Vellum.
      required:
      - update_active_workspace_id
      - update_active_environment_id
      title: UpdateActiveWorkspaceResponse
    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
    WorkflowExecutionSnapshottedBody:
      type: object
      properties:
        workflow_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
        edited_by:
          oneOf:
          - $ref: '#/components/schemas/VellumCodeResourceDefinition'
          - type: 'null'
        state:
          type: object
          additionalProperties:
            description: Any type
      required:
      - workflow_definition
      - state
      title: WorkflowExecutionSnapshottedBody
    SearchResultMeta:
      type: object
      properties:
        source:
          oneOf:
          - $ref: '#/components/schemas/SearchResultMetaSource'
          - type: 'null'
      title: SearchResultMeta
    AudioVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AudioEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumAudio'
          - type: 'null'
      required:
      - type
      - value
      description: A base Vellum primitive value representing audio.
      title: AudioVellumValue
    node.executionEnum:
      type: string
      enum:
      - node.execution
      title: node.executionEnum
    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
    WorkflowInitializationError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
      - code
      - message
      description: Workflow initialization error.
      title: WorkflowInitializationError
    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
    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
    workflow.execution.resumedEnum:
      type: string
      enum:
      - workflow.execution.resumed
      title: workflow.execution.resumedEnum
    node.execution.rejectedEnum:
      type: string
      enum:
      - node.execution.rejected
      title: node.execution.rejectedEnum
    NodeExecutionResumedEvent:
      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.resumedEnum'
        body:
          $ref: '#/components/schemas/NodeExecutionResumedBody'
        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: NodeExecutionResumedEvent
    WorkflowExecutionStreamingEvent:
      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.streamingEnum'
        body:
          $ref: '#/components/schemas/WorkflowExecutionStreamingBody'
        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: WorkflowExecutionStreamingEvent
    ChatMessageRole:
      type: string
      enum:
      - SYSTEM
      - ASSISTANT
      - USER
      - FUNCTION
      description: '* `SYSTEM` - System

        * `ASSISTANT` - Assistant

        * `USER` - User

        * `FUNCTION` - Function'
      title: ChatMessageRole
    NodeExecutionPausedEvent:
      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.pausedEnum'
        body:
          $ref: '#/components/schemas/NodeExecutionPausedBody'
        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: NodeExecutionPausedEvent
    node.execution.pausedEnum:
      type: string
      enum:
      - node.execution.paused
      title: node.execution.pausedEnum
    NumberEnum:
      type: string
      enum:
      - NUMBER
      title: NumberEnum
    ExecutionAudioVellumValue:
      type: object
      properties:
        id:
          type: string
          description: The variable's uniquely identifying internal id.
        name:
          type: string
        type:
          $ref: '#/components/schemas/AudioEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumAudio'
          - type: 'null'
      required:
      - id
      - name
      - type
      - value
      description: A base Vellum primitive value representing audio.
      title: ExecutionAudioVellumValue
    node.execution.resumedEnum:
      type: string
      enum:
      - node.execution.resumed
      title: node.execution.resumedEnum
    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
    NodeExecutionPausedBody:
      type: object
      properties:
        node_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
      required:
      - node_definition
      title: NodeExecutionPausedBody
    WorkflowExecutionSpan:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/workflow.executionEnum'
        events:
          type: array
          items:
            $ref: '#/components/schemas/VellumWorkflowExecutionEvent'
        attributes:
          $ref: '#/components/schemas/WorkflowExecutionSpanAttributes'
        usage_result:
          oneOf:
          - $ref: '#/components/schemas/WorkflowExecutionUsageCalculationFulfilledBody'
          - type: 'null'
        span_id:
          type: string
          format: uuid
        start_ts:
          type: string
          format: date-time
        end_ts:
          type: string
          format: date-time
        parent_span_id:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - name
      - events
      - attributes
      - span_id
      - start_ts
      - end_ts
      - parent_span_id
      title: WorkflowExecutionSpan
    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
    IntegrationTriggerContext:
      type: object
      properties:
        parent:
          oneOf:
          - $ref: '#/components/schemas/ParentContext'
          - type: 'null'
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SpanLink'
        type:
          $ref: '#/components/schemas/IntegrationEnum'
        trigger_id:
          type:
          - string
          - 'null'
          format: uuid
        span_id:
          type: string
          format: uuid
      required:
      - type
      - span_id
      title: IntegrationTriggerContext
    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
    StringVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/StringEnum'
        value:
          type:
          - string
          - 'null'
      required:
      - type
      - value
      description: A value representing a string.
      title: StringVellumValue
    VellumCodeResourceDefinition:
      type: object
      properties:
        name:
          type: string
        module:
          type: array
          items:
            type: string
          description: The module that this resource is defined in.
        exclude_from_monitoring:
          type:
          - boolean
          - 'null'
          description: Whether this node should be excluded from monitoring views.
        id:
          type: string
          format: uuid
      required:
      - name
      - module
      - id
      title: VellumCodeResourceDefinition
    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
    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
    WorkflowExecutionPausedBody:
      type: object
      properties:
        workflow_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
        external_inputs:
          type: array
          items:
            $ref: '#/components/schemas/ExternalInputDescriptor'
      required:
      - workflow_definition
      - external_inputs
      title: WorkflowExecutionPausedBody
    NodeExecutionFulfilledEvent:
      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.fulfilledEnum'
        body:
          $ref: '#/components/schemas/NodeExecutionFulfilledBody'
        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: NodeExecutionFulfilledEvent
    WorkflowExecutionResumedBody:
      type: object
      properties:
        workflow_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
      required:
      - workflow_definition
      title: WorkflowExecutionResumedBody
    NodeExecutionLogEvent:
      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.logEnum'
        body:
          $ref: '#/components/schemas/NodeExecutionLogBody'
        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: NodeExecutionLogEvent
    WorkflowError:
      oneOf:
      - $ref: '#/components/schemas/WorkflowEventError'
      - $ref: '#/components/schemas/WorkflowInitializationError'
      title: WorkflowError
    node.execution.logEnum:
      type: string
      enum:
      - node.execution.log
      title: node.execution.logEnum
    WorkflowExecutionRejectedEvent:
      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.rejectedEnum'
        body:
          $ref: '#/components/schemas/WorkflowExecutionRejectedBody'
        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: WorkflowExecutionRejectedEvent
    ExecutionFunctionCallVellumValue:
      type: object
      properties:
        id:
          type: string
          description: The variable's uniquely identifying internal id.
        name:
          type: string
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/FunctionCall'
          - type: 'null'
      required:
      - id
      - name
      - type
      - value
      description: A value representing a Function Call.
      title: ExecutionFunctionCallVellumValue
    workflow.execution.streamingEnum:
      type: string
      enum:
      - workflow.execution.streaming
      title: workflow.execution.streamingEnum
    WorkflowEnum:
      type: string
      enum:
      - WORKFLOW
      title: WorkflowEnum
    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
    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
    Price:
      type: object
      properties:
        value:
          type: number
          format: double
        unit:
          $ref: '#/components/schemas/UnitEnum'
      required:
      - value
      - unit
      title: Price
    node.execution.fulfilledEnum:
      type: string
      enum:
      - node.execution.fulfilled
      title: node.execution.fulfilledEnum
    VideoVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VideoEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumVideo'
          - type: 'null'
      required:
      - type
      - value
      description: A base Vellum primitive value representing a video.
      title: VideoVellumValue
    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
    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
    workflow.execution.pausedEnum:
      type: string
      enum:
      - workflow.execution.paused
      title: workflow.execution.pausedEnum
    ScheduledEnum:
      type: string
      enum:
      - SCHEDULED
      title: ScheduledEnum
    SpanLinkTypeEnum:
      type: string
      enum:
      - TRIGGERED_BY
      - PREVIOUS_SPAN
      - ROOT_SPAN
      description: '* `TRIGGERED_BY` - TRIGGERED_BY

        * `PREVIOUS_SPAN` - PREVIOUS_SPAN

        * `ROOT_SPAN` - ROOT_SPAN'
      title: SpanLinkTypeEnum
    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
    WorkflowExecutionFulfilledBody:
      type: object
      properties:
        workflow_definition:
          $ref: '#/components/schemas/VellumCodeResourceDefinition'
        outputs:
          type: object
          additionalProperties:
            description: Any type
        final_state:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        server_metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        redacted:
          type:
          - boolean
          - 'null'
      required:
      - workflow_definition
      - outputs
      title: WorkflowExecutionFulfilledBody
    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
    ExternalParentContext:
      type: object
      properties:
        parent:
          oneOf:
          - $ref: '#/components/schemas/ParentContext'
          - type: 'null'
        links:
          type:
          - array
          - 'null'
          ite

# --- 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