Vellum AI subpackage_workflowDeployments API

openapi: 3.2.0
info:
  title: Client SDK Subpackage Workflow Deployments 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:
    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
    WorkflowDeploymentReleaseWorkflowDeployment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
      - id
      - name
      title: WorkflowDeploymentReleaseWorkflowDeployment
    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
    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
    ThinkingEnum:
      type: string
      enum:
      - THINKING
      title: ThinkingEnum
    SearchResultsEnum:
      type: string
      enum:
      - SEARCH_RESULTS
      title: SearchResultsEnum
    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
    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
    WorkflowDeploymentReleaseWorkflowVersion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        input_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
        output_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
        dependencies:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WorkflowDependency'
      required:
      - id
      - input_variables
      - output_variables
      description: The workflow version associated with a workflow deployment release.
      title: WorkflowDeploymentReleaseWorkflowVersion
    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
    V1WorkflowDeploymentsIdReleaseTagsGetParametersSource:
      type: string
      enum:
      - SYSTEM
      - USER
      title: V1WorkflowDeploymentsIdReleaseTagsGetParametersSource
    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
    WorkflowDeploymentHistoryItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workflow_deployment_id:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
        label:
          type: string
          description: A human-readable label for the workflow deployment
        name:
          type: string
          description: A name that uniquely identifies this workflow deployment within its workspace
        input_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
        output_variables:
          type: array
          items:
            $ref: '#/components/schemas/VellumVariable'
        description:
          type:
          - string
          - 'null'
          description: A human-readable description of the workflow deployment
      required:
      - id
      - workflow_deployment_id
      - timestamp
      - label
      - name
      - input_variables
      - output_variables
      title: WorkflowDeploymentHistoryItem
    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
    ReleaseTagRelease:
      type: object
      properties:
        id:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
      required:
      - id
      - timestamp
      title: ReleaseTagRelease
    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
    PaginatedSlimWorkflowDeploymentList:
      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/SlimWorkflowDeployment'
      title: PaginatedSlimWorkflowDeploymentList
    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
    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

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