Vellum AI

Vellum AI subpackage_testSuiteRuns API

The subpackage_testSuiteRuns API from Vellum AI — 3 operation(s) for subpackage_testsuiteruns.

GitHub OpenAPI

Operations 3

POST /v1/test-suite-runs Create #
GET /v1/test-suite-runs/{id} Retrieve #
GET /v1/test-suite-runs/{id}/executions List Executions #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vellum/refs/heads/main/openapi/vellum-subpackage-testsuiteruns-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vellum-subpackage-testsuiteruns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vellum-subpackage-testsuiteruns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Client SDK Subpackage Test Suite Runs API
  version: 1.0.0
servers:
- url: https://predict.vellum.ai
- url: https://api.vellum.ai
- url: https://documents.vellum.ai
tags:
- name: subpackage_testSuiteRuns
paths:
  /v1/test-suite-runs:
    post:
      operationId: create
      summary: Create
      description: Trigger a Test Suite and create a new Test Suite Run
      tags:
      - subpackage_testSuiteRuns
      parameters:
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: X-API-Version
        in: header
        required: false
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestSuiteRunRead'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestSuiteRunCreateRequest'
  /v1/test-suite-runs/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Retrieve a specific Test Suite Run by ID
      tags:
      - subpackage_testSuiteRuns
      parameters:
      - name: id
        in: path
        description: A UUID string identifying this test suite run.
        required: true
        schema:
          type: string
          format: uuid
      - 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/TestSuiteRunRead'
  /v1/test-suite-runs/{id}/executions:
    get:
      operationId: list-executions
      summary: List Executions
      tags:
      - subpackage_testSuiteRuns
      parameters:
      - name: id
        in: path
        description: A UUID string identifying this test suite run.
        required: true
        schema:
          type: string
          format: uuid
      - name: expand
        in: query
        description: 'The response fields to expand for more information.

          - ''metric_results.metric_label'' expands the metric label for each metric result.

          - ''metric_results.metric_definition'' expands the metric definition for each metric result.

          - ''metric_results.metric_definition.name'' expands the metric definition name for each metric result.'
        required: false
        schema:
          type: array
          items:
            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: 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/PaginatedTestSuiteRunExecutionList'
components:
  schemas:
    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
    VideoChatMessageContentRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VideoEnum'
        value:
          $ref: '#/components/schemas/VellumVideoRequest'
      required:
      - type
      - value
      description: A video value that is used in a chat message.
      title: VideoChatMessageContentRequest
    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
    VellumDocumentRequest:
      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: VellumDocumentRequest
    NamedTestCaseArrayVariableValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ArrayEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VellumValueRequest'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type ARRAY
      title: NamedTestCaseArrayVariableValueRequest
    NamedTestCaseFunctionCallVariableValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/FunctionCallRequest'
          - type: 'null'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type FUNCTION_CALL
      title: NamedTestCaseFunctionCallVariableValueRequest
    TestSuiteRunWorkflowReleaseTagExecConfigData:
      type: object
      properties:
        workflow_deployment_id:
          type: string
          format: uuid
          description: The ID of the Workflow Deployment to run the Test Suite against.
        tag:
          type: string
          default: LATEST
          description: A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
      required:
      - workflow_deployment_id
      title: TestSuiteRunWorkflowReleaseTagExecConfigData
    ThinkingEnum:
      type: string
      enum:
      - THINKING
      title: ThinkingEnum
    SearchResultsEnum:
      type: string
      enum:
      - SEARCH_RESULTS
      title: SearchResultsEnum
    TestSuiteRunExecutionOutput:
      oneOf:
      - $ref: '#/components/schemas/TestSuiteRunExecutionStringOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionNumberOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionJsonOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionChatHistoryOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionSearchResultsOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionErrorOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionFunctionCallOutput'
      - $ref: '#/components/schemas/TestSuiteRunExecutionArrayOutput'
      title: TestSuiteRunExecutionOutput
    NamedTestCaseVideoVariableValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VideoEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumVideo'
          - type: 'null'
        name:
          type: string
      required:
      - type
      - value
      - name
      title: NamedTestCaseVideoVariableValue
    TestSuiteRunExternalExecConfig:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TestSuiteRunExternalExecConfigData'
        test_case_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
        type:
          $ref: '#/components/schemas/TestSuiteRunExternalExecConfigTypeEnum'
      required:
      - data
      description: Execution configuration for running a Vellum Test Suite against an external callable
      title: TestSuiteRunExternalExecConfig
    TestSuiteRunWorkflowReleaseTagExecConfigDataRequest:
      type: object
      properties:
        workflow_deployment_id:
          type: string
          format: uuid
          description: The ID of the Workflow Deployment to run the Test Suite against.
        tag:
          type: string
          default: LATEST
          description: A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
      required:
      - workflow_deployment_id
      title: TestSuiteRunWorkflowReleaseTagExecConfigDataRequest
    SearchResultsVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SearchResultsEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchResultRequest'
      required:
      - type
      - value
      description: A value representing Search Results.
      title: SearchResultsVellumValueRequest
    VideoEnum:
      type: string
      enum:
      - VIDEO
      title: VideoEnum
    NamedTestCaseSearchResultsVariableValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SearchResultsEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchResult'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type SEARCH_RESULTS
      title: NamedTestCaseSearchResultsVariableValue
    NamedTestCaseChatHistoryVariableValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessage'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type CHAT_HISTORY
      title: NamedTestCaseChatHistoryVariableValue
    TestSuiteRunTestSuite:
      type: object
      properties:
        id:
          type: string
          format: uuid
        history_item_id:
          type: string
          format: uuid
        label:
          type: string
      required:
      - id
      - history_item_id
      - label
      title: TestSuiteRunTestSuite
    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
    TestSuiteRunPromptSandboxExecConfigTypeEnum:
      type: string
      enum:
      - PROMPT_SANDBOX
      description: '* `PROMPT_SANDBOX` - PROMPT_SANDBOX'
      title: TestSuiteRunPromptSandboxExecConfigTypeEnum
    ThinkingVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ThinkingEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/StringVellumValueRequest'
          - type: 'null'
      required:
      - type
      - value
      description: A value representing Thinking mode output.
      title: ThinkingVellumValueRequest
    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
    TestSuiteRunDeploymentReleaseTagExecConfigDataRequest:
      type: object
      properties:
        deployment_id:
          type: string
          format: uuid
          description: The ID of the Prompt Deployment to run the Test Suite against.
        tag:
          type: string
          default: LATEST
          description: A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment
      required:
      - deployment_id
      title: TestSuiteRunDeploymentReleaseTagExecConfigDataRequest
    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
    FunctionCallRequest:
      type: object
      properties:
        arguments:
          type: object
          additionalProperties:
            description: Any type
        id:
          type:
          - string
          - 'null'
        name:
          type: string
      required:
      - arguments
      - name
      description: The final resolved function call value.
      title: FunctionCallRequest
    TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum:
      type: string
      enum:
      - PROMPT_SANDBOX_HISTORY_ITEM
      description: '* `PROMPT_SANDBOX_HISTORY_ITEM` - PROMPT_SANDBOX_HISTORY_ITEM'
      title: TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum
    TestSuiteRunMetricNumberOutputTypeEnum:
      type: string
      enum:
      - NUMBER
      description: '* `NUMBER` - NUMBER'
      title: TestSuiteRunMetricNumberOutputTypeEnum
    NamedTestCaseChatHistoryVariableValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ChatHistoryEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessageRequest'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type CHAT_HISTORY
      title: NamedTestCaseChatHistoryVariableValueRequest
    NamedTestCaseImageVariableValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ImageEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumImageRequest'
          - type: 'null'
        name:
          type: string
      required:
      - type
      - value
      - name
      title: NamedTestCaseImageVariableValueRequest
    NamedTestCaseStringVariableValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/StringEnum'
        value:
          type:
          - string
          - 'null'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type STRING
      title: NamedTestCaseStringVariableValue
    VellumAudioRequest:
      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: VellumAudioRequest
    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
    TestSuiteRunExecutionFunctionCallOutput:
      type: object
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/FunctionCall'
          - type: 'null'
        output_variable_id:
          type: string
          format: uuid
      required:
      - name
      - type
      - value
      - output_variable_id
      description: Execution output of an entity evaluated during a Test Suite Run that is of type FUNCTION_CALL
      title: TestSuiteRunExecutionFunctionCallOutput
    TestSuiteRunExecConfigRequest:
      oneOf:
      - $ref: '#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunPromptSandboxExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunWorkflowSandboxExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigRequest'
      - $ref: '#/components/schemas/TestSuiteRunExternalExecConfigRequest'
      title: TestSuiteRunExecConfigRequest
    TestSuiteRunExternalExecConfigData:
      type: object
      properties:
        executions:
          type: array
          items:
            $ref: '#/components/schemas/ExternalTestCaseExecution'
          description: The executions of some callable external to Vellum whose outputs you would like to evaluate.
      required:
      - executions
      title: TestSuiteRunExternalExecConfigData
    TestSuiteRunExternalExecConfigDataRequest:
      type: object
      properties:
        executions:
          type: array
          items:
            $ref: '#/components/schemas/ExternalTestCaseExecutionRequest'
          description: The executions of some callable external to Vellum whose outputs you would like to evaluate.
      required:
      - executions
      title: TestSuiteRunExternalExecConfigDataRequest
    DocumentVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DocumentEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumDocument'
          - type: 'null'
      required:
      - type
      - value
      description: A base Vellum primitive value representing a document.
      title: DocumentVellumValue
    TestSuiteRunMetricErrorOutput:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/VellumError'
        type:
          $ref: '#/components/schemas/TestSuiteRunMetricErrorOutputTypeEnum'
        name:
          type: string
      required:
      - value
      - name
      description: Output for a test suite run metric that is of type ERROR
      title: TestSuiteRunMetricErrorOutput
    SearchResultMetaSource:
      oneOf:
      - $ref: '#/components/schemas/PdfSearchResultMetaSource'
      title: SearchResultMetaSource
    FunctionCallChatMessageContent:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          $ref: '#/components/schemas/FunctionCallChatMessageContentValue'
      required:
      - type
      - value
      description: A function call value that is used in a chat message.
      title: FunctionCallChatMessageContent
    SearchResultRequest:
      type: object
      properties:
        text:
          type: string
          description: The text of the chunk that matched the search query.
        score:
          type: number
          format: double
          description: A score representing how well the chunk matches the search query.
        keywords:
          type: array
          items:
            type: string
        document:
          $ref: '#/components/schemas/SearchResultDocumentRequest'
          description: The document that contains the chunk that matched the search query.
        meta:
          oneOf:
          - $ref: '#/components/schemas/SearchResultMetaRequest'
          - type: 'null'
          description: Additional information about the search result.
      required:
      - text
      - score
      - keywords
      - document
      title: SearchResultRequest
    SearchResultDocumentRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
          description: The ID of the document.
        label:
          type: string
          description: The human-readable name for the document.
        external_id:
          type:
          - string
          - 'null'
          description: The unique ID of the document as represented in an external system and specified when it was originally uploaded.
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
          description: A previously supplied JSON object containing metadata that can be filtered on when searching.
      required:
      - label
      title: SearchResultDocumentRequest
    TestSuiteRunWorkflowSandboxHistoryItemExecConfig:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigTypeEnum'
        data:
          $ref: '#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigData'
        test_case_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
      required:
      - data
      description: Execution configuration for running a Test Suite against a Workflow Sandbox History Item
      title: TestSuiteRunWorkflowSandboxHistoryItemExecConfig
    ImageVellumValue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ImageEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumImage'
          - type: 'null'
      required:
      - type
      - value
      description: A base Vellum primitive value representing an image.
      title: ImageVellumValue
    TestSuiteRunDeploymentReleaseTagExecConfigRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum'
        data:
          $ref: '#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigDataRequest'
        test_case_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
      required:
      - data
      description: Execution configuration for running a Test Suite against a Prompt Deployment
      title: TestSuiteRunDeploymentReleaseTagExecConfigRequest
    FunctionCallChatMessageContentRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FunctionCallEnum'
        value:
          $ref: '#/components/schemas/FunctionCallChatMessageContentValueRequest'
      required:
      - type
      - value
      description: A function call value that is used in a chat message.
      title: FunctionCallChatMessageContentRequest
    TestSuiteRunPromptSandboxHistoryItemExecConfigRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum'
        data:
          $ref: '#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest'
        test_case_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
      required:
      - data
      description: Execution configuration for running a Test Suite against a Prompt Sandbox History Item
      title: TestSuiteRunPromptSandboxHistoryItemExecConfigRequest
    TestSuiteRunExecConfig:
      oneOf:
      - $ref: '#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfig'
      - $ref: '#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfig'
      - $ref: '#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfig'
      - $ref: '#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfig'
      - $ref: '#/components/schemas/TestSuiteRunExternalExecConfig'
      title: TestSuiteRunExecConfig
    TestSuiteRunMetricStringOutput:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/TestSuiteRunMetricStringOutputTypeEnum'
        name:
          type: string
      required:
      - value
      - name
      description: Output for a test suite run metric that is of type STRING
      title: TestSuiteRunMetricStringOutput
    ArrayVellumValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ArrayEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VellumValueRequest'
      required:
      - type
      - value
      description: A value representing an array of Vellum variable values.
      title: ArrayVellumValueRequest
    VellumErrorRequest:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/VellumErrorCodeEnum'
        message:
          type: string
        raw_data:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      required:
      - code
      - message
      title: VellumErrorRequest
    TestSuiteRunDeploymentReleaseTagExecConfigData:
      type: object
      properties:
        deployment_id:
          type: string
          format: uuid
          description: The ID of the Prompt Deployment to run the Test Suite against.
        tag:
          type: string
          default: LATEST
          description: A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment
      required:
      - deployment_id
      title: TestSuiteRunDeploymentReleaseTagExecConfigData
    PdfSearchResultMetaSource:
      type: object
      properties:
        document_type:
          $ref: '#/components/schemas/PdfEnum'
        start_page_num:
          type:
          - integer
          - 'null'
          description: The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
        end_page_num:
          type:
          - integer
          - 'null'
          description: The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
      required:
      - document_type
      - start_page_num
      - end_page_num
      description: The source of a search result from a PDF document.
      title: PdfSearchResultMetaSource
    TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest:
      type: object
      properties:
        history_item_id:
          type: string
          format: uuid
          description: The ID of the Prompt Sandbox History Item that the Test Suite will run against.
        prompt_variant_id:
          type: string
          format: uuid
          description: The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd like to run the Test Suite against.
      required:
      - history_item_id
      - prompt_variant_id
      title: TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest
    TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum:
      type: string
      enum:
      - WORKFLOW_RELEASE_TAG
      description: '* `WORKFLOW_RELEASE_TAG` - WORKFLOW_RELEASE_TAG'
      title: TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum
    TestSuiteRunExecutionArrayOutput:
      type: object
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/ArrayEnum'
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VellumValue'
        output_variable_id:
          type: string
          format: uuid
      required:
      - name
      - type
      - value
      - output_variable_id
      description: Execution output of an entity evaluated during a Test Suite Run that is of type ARRAY
      title: TestSuiteRunExecutionArrayOutput
    NamedTestCaseAudioVariableValueRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AudioEnum'
        value:
          oneOf:
          - $ref: '#/components/schemas/VellumAudioRequest'
          - type: 'null'
        name:
          type: string
      required:
      - type
      - value
      - name
      description: Named Test Case value that is of type AUDIO
      title: NamedTestCaseAudioVariableValueRequest
    NamedTestCaseFunctionCallVariableValue:
      type: object
      prope

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