Vellum AI subpackage_workflowDeployments API

openapi: 3.1.0
info:
  title: Client SDK subpackage_workflowDeployments API
  version: 1.0.0
servers:
- url: https://predict.vellum.ai
- url: https://api.vellum.ai
- url: https://documents.vellum.ai
tags:
- name: subpackage_workflowDeployments
paths:
  /v1/workflow-deployments/{id}/execute-stream:
    post:
      operationId: execute-stream
      summary: Execute Stream
      description: Executes a deployed Workflow and streams back its results.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - 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:
            text/event-stream:
              schema:
                $ref: '#/components/schemas/WorkflowEvent'
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteWorkflowDeploymentStreamRequest'
  /v1/workflow-deployments:
    get:
      operationId: list
      summary: List
      description: Used to list all Workflow Deployments.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: has_story_config
        in: query
        description: has_story_config
        required: false
        schema:
          type: string
      - name: is_public
        in: query
        description: is_public
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        description: The initial index from which to return the results.
        required: false
        schema:
          type: integer
      - name: ordering
        in: query
        description: 'Specifies the ordering of the returned Workflow Deployments. Valid values are:

          - `created` - Orders by creation time in ascending order.

          - `-created` - Orders by creation time in descending order. (default)

          - `name` - Orders by name in ascending order.

          - `-name` - Orders by name in descending order.


          Compound orderings are supported by separating fields with commas, e.g., `-created,name`.

          '
        required: false
        schema:
          type: string
      - name: owned_by
        in: query
        description: owned_by
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: status
        required: false
        schema:
          $ref: '#/components/schemas/V1WorkflowDeploymentsGetParametersStatus'
      - 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/PaginatedSlimWorkflowDeploymentList'
  /v1/workflow-deployments/{id}/releases:
    get:
      operationId: list-workflow-deployment-releases
      summary: List Workflow Deployment Releases
      description: List the Releases of the specified Workflow Deployment for the current Environment.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        description: The initial index from which to return the results.
        required: false
        schema:
          type: integer
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - 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/PaginatedWorkflowDeploymentReleaseList'
  /v1/workflow-deployments/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Used to retrieve a workflow deployment given its ID or name.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - 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/WorkflowDeploymentRead'
  /v1/workflow-deployments/{id}/releases/{release_id_or_release_tag}:
    get:
      operationId: retrieve-workflow-deployment-release
      summary: Retrieve Workflow Deployment Release
      description: Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - name: release_id_or_release_tag
        in: path
        description: Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.
        required: true
        schema:
          type: string
      - 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/WorkflowDeploymentRelease'
  /v1/workflow-deployments/{id}/release-tags/{name}:
    get:
      operationId: retrieve-workflow-release-tag
      summary: Retrieve Workflow Release Tag
      description: Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
        required: true
        schema:
          type: string
      - 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/WorkflowReleaseTagRead'
    patch:
      operationId: update-workflow-release-tag
      summary: Update Workflow Release Tag
      description: Updates an existing Release Tag associated with the specified Workflow Deployment.
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
        required: true
        schema:
          type: string
      - 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/WorkflowReleaseTagRead'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowReleaseTagUpdateRequest'
  /v1/workflow-deployments/{id}/release-tags:
    get:
      operationId: list-workflow-release-tags
      summary: List Workflow Release Tags
      description: List Release Tags associated with the specified Workflow Deployment
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        description: The initial index from which to return the results.
        required: false
        schema:
          type: integer
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: source
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/V1WorkflowDeploymentsIdReleaseTagsGetParametersSource'
      - 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/PaginatedWorkflowReleaseTagReadList'
  /v1/workflow-deployments/{id}/history/{history_id_or_release_tag}:
    get:
      operationId: workflow-deployment-history-item-retrieve
      summary: Workflow Deployment History Item Retrieve
      description: 'DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the

        `retrieve_workflow_deployment_release` endpoint instead.'
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: history_id_or_release_tag
        in: path
        description: Either the UUID of Workflow Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment History Item you'd like to retrieve.
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Either the Workflow Deployment's ID or its unique name
        required: true
        schema:
          type: string
      - 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/WorkflowDeploymentHistoryItem'
  /v1/workflow-deployments/{id}/execution-events:
    get:
      operationId: list-workflow-deployment-event-executions
      summary: List Workflow Deployment Event Executions
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: filters
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of executions to return per page.
        required: false
        schema:
          type: integer
      - name: offset
        in: query
        description: The initial index from which to return the executions.
        required: false
        schema:
          type: integer
      - name: ordering
        in: query
        required: false
        schema:
          type: string
      - 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/WorkflowDeploymentEventExecutionsResponse'
  /v1/workflow-deployments/{id}/execution-events/{execution_id}:
    get:
      operationId: workflow-deployment-event-execution
      summary: Workflow Deployment Event Execution
      tags:
      - subpackage_workflowDeployments
      parameters:
      - name: execution_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        required: true
        schema:
          type: string
      - 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/WorkflowEventExecutionRead'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetailResponse'
        '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
    EntityStatus:
      type: string
      enum:
      - ACTIVE
      - ARCHIVED
      - PENDING_DELETION
      description: '* `ACTIVE` - Active

        * `ARCHIVED` - Archived

        * `PENDING_DELETION` - Pending Deletion'
      title: EntityStatus
    workflow.execution.snapshottedEnum:
      type: string
      enum:
      - workflow.execution.snapshotted
      title: workflow.execution.snapshottedEnum
    ReleaseReviewReviewer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        full_name:
          type: string
      required:
      - id
      title: ReleaseReviewReviewer
    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
    WorkflowModelProviderDependency:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ModelProviderEnum'
        name:
          $ref: '#/components/schemas/MLModelHostingInterface'
        label:
          type:
          - string
          - 'null'
        model_name:
          type: string
      required:
      - type
      - name
      - model_name
      title: WorkflowModelProviderDependency
    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
    WorkflowExecutionActual:
      type: object
      properties:
        output:
          $ref: '#/components/schemas/ExecutionVellumValue'
        timestamp:
          type: string
          format: date-time
        quality:
          type:
          - number
          - 'null'
          format: double
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      required:
      - output
      - timestamp
      - metadata
      title: WorkflowExecutionActual
    VellumVariableType:
      type: string
      enum:
      - STRING
      - NUMBER
      - JSON
      - CHAT_HISTORY
      - SEARCH_RESULTS
      - ERROR
      - ARRAY
      - FUNCTION_CALL
      - AUDIO
      - VIDEO
      - IMAGE
      - DOCUMENT
      - 'NULL'
      - THINKING
      - REFERENCE
      description: '* `STRING` - STRING

        * `NUMBER` - NUMBER

        * `JSON` - JSON

        * `CHAT_HISTORY` - CHAT_HISTORY

        * `SEARCH_RESULTS` - SEARCH_RESULTS

        * `ERROR` - ERROR

        * `ARRAY` - ARRAY


        * `FUNCTION_CALL` - FUNCTION_CALL

        * `AUDIO` - AUDIO

        * `VIDEO` - VIDEO

        * `IMAGE` - IMAGE

        * `DOCUMENT` - DOCUMENT

        * `NULL` - NULL

        * `THINKING` - THINKING

        * `REFERENCE` - REFERENCE'
      title: VellumVariableType
    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
    ModelProviderEnum:
      type: string
      enum:
      - MODEL_PROVIDER
      title: ModelProviderEnum
    PatchedWorkflowReleaseTagUpdateRequest:
      type: object
      properties:
        history_item_id:
          type: string
          format: uuid
          description: The ID of the Workflow Deployment History Item to tag
      title: PatchedWorkflowReleaseTagUpdateRequest
    IntegrationEnum:
      type: string
      enum:
      - INTEGRATION
      title: IntegrationEnum
    WorkflowDeploymentReleaseWorkflowDeployment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
      - id
      - name
      title: WorkflowDeploymentReleaseWorkflowDeployment
    WorkflowIntegrationDependency:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/IntegrationEnum'
        name:
          $ref: '#/components/schemas/IntegrationName'
        provider:
          type: string
        label:
          type:
          - string
          - 'null'
      required:
      - type
      - name
      - provider
      title: WorkflowIntegrationDependency
    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
    PaginatedWorkflowReleaseTagReadList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
          format: uri
        previous:
          type:
          - string
          - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowReleaseTagRead'
      title: PaginatedWorkflowReleaseTagReadList
    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
    SlimWorkflowDeployment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: A name that uniquely identifies this workflow deployment within its workspace
        label:
          type: string
          description: A human-readable label for the workflow deployment
        status:
          $ref: '#/components/schemas/EntityStatus'
          description: 'The current status of the workflow deployment


            * `ACTIVE` - Active

            * `ARCHIVED` - Archived

            * `PENDING_DELETION` - Pending Deletion'
        environment:
          oneOf:
          - $ref: '#/components/schemas/EnvironmentEnum'
          - type: 'null'
          description: Deprecated. The value returned will always be 'PRODUCTION'.
        created:
          type: string
          format: date-time
        last_deployed_on:
          type: string
          format: date-time
        input_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
          description: The input variables this Workflow Deployment expects to receive values for when it is executed.
        output_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
          description: The output variables this Workflow Deployment will produce when it is executed.
        description:
          type:
          - string
          - 'null'
          description: A human-readable description of the workflow deployment
      required:
      - id
      - name
      - label
      - created
      - last_deployed_on
      - input_variables
      - output_variables
      description: A subset of a Workflow Deployment's full details.
      title: SlimWorkflowDeployment
    SearchResultMeta:
      type: object
      properties:
        source:
          oneOf:
          - $ref: '#/components/schemas/SearchResultMetaSource'
          - type: 'null'
      title: SearchResultMeta
    ReleaseReviewState:
      type: string
      enum:
      - APPROVED
      - CHANGES_REQUESTED
      - COMMENTED
      description: '* `APPROVED` - Approved

        * `CHANGES_REQUESTED` - Changes Requested

        * `COMMENTED` - Commented'
      title: ReleaseReviewState
    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
    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
    WorkflowInitializationError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
      - code
      - message
      description: Workflow initialization error.
      title: WorkflowInitializationError
    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
    ChatMessageRole:
      type: string
      enum:
      - SYSTEM
      - ASSISTANT
      - USER
      - FUNCTION
      description: '* `SYSTEM` - System

        * `ASSISTANT` - Assistant

        * `USER` - User

        * `FUNCTION` - Function'
      title: ChatMessageRole
    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
          forma

# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vellum/refs/heads/main/openapi/vellum-subpackage-workflowdeployments-api-openapi.yml