Vellum AI Default API

openapi: 3.1.0
info:
  title: Client SDK  API
  version: 1.0.0
servers:
- url: https://predict.vellum.ai
- url: https://api.vellum.ai
- url: https://documents.vellum.ai
tags:
- name: ''
paths:
  /v1/execute-prompt:
    post:
      operationId: execute-prompt
      summary: Execute Prompt
      description: Executes a deployed Prompt and returns the result.
      tags:
      - ''
      parameters:
      - 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/ExecutePromptResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutePromptRequest'
  /v1/execute-prompt-stream:
    post:
      operationId: execute-prompt-stream
      summary: Execute Prompt Stream
      description: Executes a deployed Prompt and streams back the results.
      tags:
      - ''
      parameters:
      - 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/ExecutePromptEvent'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutePromptApiErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutePromptStreamRequest'
  /v1/submit-completion-actuals:
    post:
      operationId: submit-completion-actuals
      summary: Submit Completion Actuals
      description: Used to submit feedback regarding the quality of previously generated completions.
      tags:
      - ''
      parameters:
      - 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: No response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submit-completion-actuals_Response_200'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitCompletionActualsErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitCompletionActualsErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitCompletionActualsErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitCompletionActualsRequest'
  /v1/execute-workflow:
    post:
      operationId: execute-workflow
      summary: Execute Workflow
      description: Executes a deployed Workflow and returns its outputs.
      tags:
      - ''
      parameters:
      - 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/ExecuteWorkflowResponse'
        '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:
                $ref: '#/components/schemas/ExecuteWorkflowErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteWorkflowRequest'
  /v1/execute-workflow-async:
    post:
      operationId: execute-workflow-async
      summary: Execute Workflow Async
      description: Executes a deployed Workflow asynchronously and returns the execution ID.
      tags:
      - ''
      parameters:
      - 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/ExecuteWorkflowAsyncResponse'
        '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:
                $ref: '#/components/schemas/ExecuteWorkflowStreamErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteWorkflowAsyncRequest'
  /v1/execute-workflow-stream:
    post:
      operationId: execute-workflow-stream
      summary: Execute Workflow Stream
      description: Executes a deployed Workflow and streams back its results.
      tags:
      - ''
      parameters:
      - 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/WorkflowStreamEvent'
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteWorkflowStreamErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteWorkflowStreamErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteWorkflowStreamRequest'
  /v1/submit-workflow-execution-actuals:
    post:
      operationId: submit-workflow-execution-actuals
      summary: Submit Workflow Execution Actuals
      description: "    Used to submit feedback regarding the quality of previous workflow execution and its outputs.\n\n    **Note:** Uses a base url of `https://predict.vellum.ai`.    "
      tags:
      - ''
      parameters:
      - 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: No response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submit-workflow-execution-actuals_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitWorkflowExecutionActualsRequest'
  /v1/search:
    post:
      operationId: search
      summary: Search
      description: Perform a search against a document index.
      tags:
      - ''
      parameters:
      - 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/SearchResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequestBodyRequest'
components:
  schemas:
    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
    TemplatingNodeSearchResultsResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/SearchResultsEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchResult'
      required:
      - id
      - type
      - value
      title: TemplatingNodeSearchResultsResult
    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
    WorkflowOutput:
      oneOf:
      - $ref: '#/components/schemas/WorkflowOutputString'
      - $ref: '#/components/schemas/WorkflowOutputNumber'
      - $ref: '#/components/schemas/WorkflowOutputJSON'
      - $ref: '#/components/schemas/WorkflowOutputChatHistory'
      - $ref: '#/components/schemas/WorkflowOutputSearchResults'
      - $ref: '#/components/schemas/WorkflowOutputArray'
      - $ref: '#/components/schemas/WorkflowOutputError'
      - $ref: '#/components/schemas/WorkflowOutputFunctionCall'
      - $ref: '#/components/schemas/WorkflowOutputImage'
      - $ref: '#/components/schemas/WorkflowOutputAudio'
      - $ref: '#/components/schemas/WorkflowOutputVideo'
      - $ref: '#/components/schemas/WorkflowOutputDocument'
      title: WorkflowOutput
    ExecutePromptEvent:
      oneOf:
      - $ref: '#/components/schemas/InitiatedExecutePromptEvent'
      - $ref: '#/components/schemas/StreamingExecutePromptEvent'
      - $ref: '#/components/schemas/FulfilledExecutePromptEvent'
      - $ref: '#/components/schemas/RejectedExecutePromptEvent'
      title: ExecutePromptEvent
    WorkflowOutputChatHistory:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: The output's name, as defined in the workflow
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessage'
      required:
      - id
      - name
      - type
      - value
      description: A chat history output from a Workflow execution.
      title: WorkflowOutputChatHistory
    WorkflowRequestNumberInputRequest:
      type: object
      properties:
        name:
          type: string
          description: The variable's name, as defined in the Workflow.
        type:
          $ref: '#/components/schemas/NumberEnum'
        value:
          type: number
          format: double
      required:
      - name
      - type
      - value
      description: The input for a number variable in a Workflow.
      title: WorkflowRequestNumberInputRequest
    MetricEnum:
      type: string
      enum:
      - METRIC
      title: MetricEnum
    NodeOutputCompiledValue:
      oneOf:
      - $ref: '#/components/schemas/NodeOutputCompiledStringValue'
      - $ref: '#/components/schemas/NodeOutputCompiledNumberValue'
      - $ref: '#/components/schemas/NodeOutputCompiledJsonValue'
      - $ref: '#/components/schemas/NodeOutputCompiledChatHistoryValue'
      - $ref: '#/components/schemas/NodeOutputCompiledSearchResultsValue'
      - $ref: '#/components/schemas/NodeOutputCompiledErrorValue'
      - $ref: '#/components/schemas/NodeOutputCompiledArrayValue'
      - $ref: '#/components/schemas/NodeOutputCompiledFunctionCallValue'
      - $ref: '#/components/schemas/NodeOutputCompiledThinkingValue'
      title: NodeOutputCompiledValue
    CodeExecutionNodeSearchResultsResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/SearchResultsEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchResult'
      required:
      - id
      - type
      - value
      title: CodeExecutionNodeSearchResultsResult
    DocumentChatMessageContentRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DocumentEnum'
        value:
          $ref: '#/components/schemas/VellumDocumentRequest'
      required:
      - type
      - value
      description: A document value that is used in a chat message.
      title: DocumentChatMessageContentRequest
    SearchRequestOptionsRequest:
      type: object
      properties:
        limit:
          type:
          - integer
          - 'null'
          default: 10
          description: The maximum number of results to return.
        weights:
          oneOf:
          - $ref: '#/components/schemas/SearchWeightsRequest'
          - type: 'null'
          description: The weights to use for the search. Must add up to 1.0.
        result_merging:
          oneOf:
          - $ref: '#/components/schemas/SearchResultMergingRequest'
          - type: 'null'
          description: The configuration for merging results.
        filters:
          oneOf:
          - $ref: '#/components/schemas/SearchFiltersRequest'
          - type: 'null'
          description: The filters to apply to the search.
      title: SearchRequestOptionsRequest
    SearchFiltersRequest:
      type: object
      properties:
        external_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The document external IDs to filter by
        metadata:
          oneOf:
          - $ref: '#/components/schemas/MetadataFiltersRequest'
          - type: 'null'
          description: The metadata filters to apply to the search
      title: SearchFiltersRequest
    CodeExecutionNodeNumberResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/NumberEnum'
        value:
          type:
          - number
          - 'null'
          format: double
      required:
      - id
      - type
      - value
      title: CodeExecutionNodeNumberResult
    NodeEnum:
      type: string
      enum:
      - NODE
      title: NodeEnum
    FunctionCallVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/FunctionCallRequest'
          - type: 'null'
      required:
      - type
      - value
      description: A value representing a Function Call.
      title: FunctionCallVellumValueRequest
    TemplatingNodeResultOutput:
      oneOf:
      - $ref: '#/components/schemas/TemplatingNodeStringResult'
      - $ref: '#/components/schemas/TemplatingNodeNumberResult'
      - $ref: '#/components/schemas/TemplatingNodeJsonResult'
      - $ref: '#/components/schemas/TemplatingNodeChatHistoryResult'
      - $ref: '#/components/schemas/TemplatingNodeSearchResultsResult'
      - $ref: '#/components/schemas/TemplatingNodeErrorResult'
      - $ref: '#/components/schemas/TemplatingNodeArrayResult'
      - $ref: '#/components/schemas/TemplatingNodeFunctionCallResult'
      title: TemplatingNodeResultOutput
    StreamingEnum:
      type: string
      enum:
      - STREAMING
      title: StreamingEnum
    CodeExecutionNodeResultData:
      type: object
      properties:
        output:
          $ref: '#/components/schemas/CodeExecutionNodeResultOutput'
        log_output_id:
          type:
          - string
          - 'null'
      required:
      - output
      title: CodeExecutionNodeResultData
    ChatHistoryVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessageRequest'
      required:
      - type
      - value
      description: A value representing Chat History.
      title: ChatHistoryVellumValueRequest
    StreamingPromptExecutionMeta:
      type: object
      properties:
        latency:
          type:
          - integer
          - 'null'
      description: The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
      title: StreamingPromptExecutionMeta
    NodeInputCompiledVideoValue:
      type: object
      properties:
        node_input_id:
          type: string
        key:
          type: string
        type:
          $ref: '#/components/schemas/VideoEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumVideo'
          - type: 'null'
      required:
      - node_input_id
      - key
      - type
      - value
      title: NodeInputCompiledVideoValue
    WorkflowResultEventOutputData:
      oneOf:
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataString'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataNumber'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataJSON'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataChatHistory'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataSearchResults'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataArray'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataFunctionCall'
      - $ref: '#/components/schemas/WorkflowResultEventOutputDataError'
      title: WorkflowResultEventOutputData
    ExecuteWorkflowAsyncResponse:
      type: object
      properties:
        execution_id:
          type: string
          description: The ID of the workflow execution.
      required:
      - execution_id
      description: The response from an async Workflow Deployment execution.
      title: ExecuteWorkflowAsyncResponse
    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
    NodeInputCompiledAudioValue:
      type: object
      properties:
        node_input_id:
          type: string
        key:
          type: string
        type:
          $ref: '#/components/schemas/AudioEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumAudio'
          - type: 'null'
      required:
      - node_input_id
      - key
      - type
      - value
      title: NodeInputCompiledAudioValue
    ConditionalEnum:
      type: string
      enum:
      - CONDITIONAL
      title: ConditionalEnum
    Price:
      type: object
      properties:
        value:
          type: number
          format: double
        unit:
          $ref: '#/components/schemas/UnitEnum'
      required:
      - value
      - unit
      title: Price
    SubworkflowNodeResultData:
      type: object
      properties:
        execution_id:
          type:
          - string
          - 'null'
          format: uuid
      title: SubworkflowNodeResultData
    CodeExecutionNodeArrayResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/ArrayEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VellumValue'
      required:
      - id
      - type
      - value
      title: CodeExecutionNodeArrayResult
    submit-workflow-execution-actuals_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: submit-workflow-execution-actuals_Response_200
    RejectedPromptExecutionMeta:
      type: object
      properties:
        latency:
          type:
          - integer
          - 'null'
        finish_reason:
          oneOf:
          - $ref: '#/components/schemas/FinishReasonEnum'
          - type: 'null'
      description: The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
      title: RejectedPromptExecutionMeta
    AudioEnum:
      type: string
      enum:
      - AUDIO
      title: AudioEnum
    InitiatedEnum:
      type: string
      enum:
      - INITIATED
      title: InitiatedEnum
    MergeNodeResultData:
      type: object
      properties:
        paused_node_data:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      title: MergeNodeResultData
    VellumError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/VellumErrorCodeEnum'
        message:
          type: string
        raw_data:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      required:
      - code
      - message
      title: VellumError
    WorkflowEventErrorRawData:
      oneOf:
      - type: object
        additionalProperties:
          description: Any type
      - type: string
      title: WorkflowEventErrorRawData
    SubmitCompletionActualsErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      title: SubmitCompletionActualsErrorResponse
    MetadataFilterRuleCombinator:
      type: string
      enum:
      - and
      - or
      description: '* `and` - AND

        * `or` - OR'
      title: MetadataFilterRuleCombinator
    VellumVideoRequest:
      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: VellumVideoRequest
    ExecutionSearchResultsVellumValue:
      type: object
      properties:
        id:
          type: string
          description: The variable's uniquely identifying internal id.
        name:
          type: string
        type:
          $ref: '#/components/schemas/SearchResultsEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchResult'
      required:
      - id
      - name
      - type
      - value
      description: A value representing Search Results.
      title: ExecutionSearchResultsVellumValue
    RejectedEnum:
      type: string
      enum:
      - REJECTED
      title: RejectedEnum
    SecretEnum:
      type: string
      enum:
      - SECRET
      title: SecretEnum
    ThinkingEnum:
      type: string
      enum:
      - THINKING
      title: ThinkingEnum
    PromptNodeExecutionMeta:
      type: object
      properties:
        usage:
          oneOf:
          - $ref: '#/components/schemas/MLModelUsage'
          - type: 'null'
        cost:
          oneOf:
          - $ref: '#/components/schemas/Price'
          - type: 'null'
        model_name:
          type:
          - string
          - 'null'
      description: The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
      title: PromptNodeExecutionMeta
    WorkflowOutputError:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: The output's name, as defined in the workflow
        type:
          $ref: '#/components/schemas/ErrorEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumError'
          - type: 'null'
      required:
      - id
      - name
      - type
      - value
      description: An error output from a Workflow execution.
      title: WorkflowOutputError
    MergeEnum:
      type: string
      enum:
      - MERGE
      title: MergeEnum
    SearchResultMergingRequest:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
          description: Whether to enable merging results
      title: SearchResultMergingRequest
    AudioVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AudioEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumAudioRequest'
          - type: 'null'
      required:
      - type
      - value
      description: A base Vellum primitive value representing audio.
      title: AudioVellumValueRequest
    FulfilledExecutePromptEvent:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/FulfilledEnum'
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/PromptOutput'
        execution_id:
          type: string
        meta:
          $ref: '#/components/schemas/FulfilledPromptExecutionMeta'
        chat_message_metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      required:
      - state
      - outputs
      - execution_id
      description: The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
      title: FulfilledExecutePromptEvent
    FunctionCallEnum:
      type: string
      enum:
      - FUNCTION_CALL
      title: FunctionCallEnum
    PromptNodeResult:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PromptEnum'
        data:
          $ref: '#/components/schemas/PromptNodeResultData'
      required:
      - type
      - data
      description: A Node Result Event emitted from a Prompt Node.
      title: PromptNodeResult
    ExecutionThinkingVellumValue:
      type: object
      properties:
        id:
          type: string
          description: The variable's uniquely identifying internal id.
        name:
          type: string
        type:
          $ref: '#/components/schemas/ThinkingEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/StringVellumValue'
          - type: 'null'
      required:
      - id
      - name
      - type
      - value
      description: A value representing Thinking mode output.
      title: ExecutionThinkingVellumValue
    TemplatingNodeChatHistoryResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessage'
      required:
      - id
      - type
      - value
      title: TemplatingNodeChatHistoryResult
    TemplatingNodeNumberResult:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/NumberEnum'
        value:
          type:
          - number
          - 'null'
          format: double
      required:
      - id
      - type
      - value
      title: TemplatingNodeNumberResult
    WorkflowEventError:
      type: object
      properties:
        message:
          type: string
        raw_data:
          oneOf:
          - $ref: '#/components/schemas/WorkflowEventErrorRawData'
          - type: 'null'
        code:
          $ref: '#/components/schemas/WorkflowExecutionEventErrorCode'
        stacktrace:
          type:
          - string
          - 'null'
      required:
      - message
      - code
      title: WorkflowEventError
    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
    SearchResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchResult'
          description: T

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