HUD

HUD Qa API

The qa API from HUD — 3 operation(s) for qa.

GitHub OpenAPI

Operations 3

GET /v2/qa/checks List Qa Checks #
POST /v2/qa/runs Run Qa Checks #
GET /v2/qa/results List Qa Results #

Documentation

📖
APIReference
https://api.beta.hud.ai/docs
📖
Documentation
https://docs.hud.ai/platform/rest-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hud-ai/openapi/hud-ai-qa-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-info-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-model-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-registry-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-register-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-analysis-context-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-response-schema.json

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/hud-ai:hud-ai-qa-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

hud-ai-qa-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HUD Platform Qa API
  version: 2.0.0
tags:
- name: qa
paths:
  /v2/qa/checks:
    get:
      tags:
      - qa
      summary: List Qa Checks
      description: List the QA checks available to run, each with the subject type it judges.
      operationId: list_qa_checks_v2_qa_checks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QaCheckListResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/qa/runs:
    post:
      tags:
      - qa
      summary: Run Qa Checks
      description: Run QA checks against completed evaluation traces or tasks as one run; returns each subject's result of each check.
      operationId: run_qa_checks_v2_qa_runs_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QaRunCreateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QaResultListResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/qa/results:
    get:
      tags:
      - qa
      summary: List Qa Results
      description: 'List the result in effect for every QA check on the given evaluation traces or tasks.


        A task''s results in effect are those on its current version. With

        ``include_history``, list every result instead, newest first, across a

        task''s versions.'
      operationId: list_qa_results_v2_qa_results_get
      parameters:
      - name: trace_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 100
          - type: 'null'
          title: Trace Ids
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 100
          - type: 'null'
          title: Task Ids
      - name: include_history
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include History
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QaResultListResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    QaResultSource:
      type: string
      enum:
      - analysis
      - skipped
      - manual
      title: QaResultSource
      description: Where a result's verdict comes from.
    QaCheckListResponse:
      properties:
        checks:
          items:
            $ref: '#/components/schemas/QaCheckResponse'
          type: array
          title: Checks
      type: object
      required:
      - checks
      title: QaCheckListResponse
    QaResultStatus:
      type: string
      enum:
      - queued
      - running
      - cancelling
      - completed
      - error
      - cancelled
      title: QaResultStatus
    QaResultResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        check_key:
          type: string
          title: Check Key
        subject_type:
          $ref: '#/components/schemas/QaSubjectType'
        subject_trace_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Subject Trace Id
        subject_task_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Subject Task Id
        subject_task_version_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Subject Task Version Id
        source:
          $ref: '#/components/schemas/QaResultSource'
        status:
          $ref: '#/components/schemas/QaResultStatus'
        verdict:
          anyOf:
          - type: string
            enum:
            - passed
            - failed
            - unknown
          - type: 'null'
          title: Verdict
        result:
          anyOf:
          - $ref: '#/components/schemas/QaCheckResultV1'
          - type: 'null'
        legacy_result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Legacy Result
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        created_at:
          type: string
          format: date-time
          title: Created At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        run_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Run Id
        analysis_trace_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Analysis Trace Id
      type: object
      required:
      - id
      - check_key
      - subject_type
      - source
      - status
      - created_at
      title: QaResultResponse
      description: 'One result of a check on a subject: a trace, or a version of a task.'
    QaSubjectType:
      type: string
      enum:
      - trace
      - task
      title: QaSubjectType
      description: 'What a check judges: a completed evaluation trace, or a task''s current version.'
    QaCheckResponse:
      properties:
        key:
          type: string
          title: Key
        subject_type:
          $ref: '#/components/schemas/QaSubjectType'
        title:
          type: string
          title: Title
        question:
          type: string
          title: Question
        description:
          type: string
          title: Description
      type: object
      required:
      - key
      - subject_type
      - title
      - question
      - description
      title: QaCheckResponse
    QaResultListResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/QaResultResponse'
          type: array
          title: Results
      type: object
      required:
      - results
      title: QaResultListResponse
    QaCheckFindingV1:
      properties:
        finding_type:
          type: string
          title: Finding Type
        severity:
          type: string
          enum:
          - info
          - warning
          - error
          title: Severity
        summary:
          type: string
          title: Summary
        confidence:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Confidence
        evidence_refs:
          items:
            type: string
          type: array
          title: Evidence Refs
        recommended_action:
          anyOf:
          - type: string
          - type: 'null'
          title: Recommended Action
        metadata:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Metadata
      additionalProperties: false
      type: object
      required:
      - finding_type
      - severity
      - summary
      title: QaCheckFindingV1
      description: One actionable issue a QA check identified.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        source:
          $ref: '#/components/schemas/ErrorSource'
        detail:
          type: string
          title: Detail
      type: object
      required:
      - error
      - source
      - detail
      title: ErrorResponse
      description: The uniform `{error, source, detail}` envelope returned for every 4xx/5xx.
    QaRunCreateRequest:
      properties:
        trace_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
            maxItems: 100
            minItems: 1
          - type: 'null'
          title: Trace Ids
        task_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
            maxItems: 100
            minItems: 1
          - type: 'null'
          title: Task Ids
        check_keys:
          items:
            type: string
          type: array
          minItems: 1
          title: Check Keys
        overwrite:
          type: boolean
          title: Overwrite
          default: true
      type: object
      required:
      - check_keys
      title: QaRunCreateRequest
      description: 'Run each check on each subject; the request''s analysis rollouts share one hidden QA job.


        Every check must judge the subjects'' type. A task subject is its current version.'
    QaExecutionError:
      properties:
        stage:
          type: string
          maxLength: 64
          minLength: 1
          pattern: ^[a-z][a-z0-9_]*$
          title: Stage
        reason:
          type: string
          maxLength: 1000
          minLength: 1
          title: Reason
      additionalProperties: false
      type: object
      required:
      - stage
      - reason
      title: QaExecutionError
      description: 'A step of a check that did not finish.


        ``reason`` is shown to everyone who can read the result, so producers write it

        from code: no model output, raw analysis context, or credentials.'
    ErrorSource:
      type: string
      enum:
      - user
      - platform
      - provider
      title: ErrorSource
      description: 'Who is at fault for a failure.


        ``user``: the customer''s input, account, environment, or agent code.

        ``platform``: HUD infrastructure or a broken platform invariant.

        ``provider``: a third-party dependency (cloud runtime, upstream LLM API).'
    JsonValue: {}
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        error:
          type: string
          const: validation_error
          title: Error
        source:
          type: string
          enum:
          - user
          - platform
          - provider
          title: Source
        detail:
          type: string
          title: Detail
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Errors
      required:
      - error
      - source
      - detail
      - errors
    ValidationError:
      title: ValidationError
      type: object
      properties:
        type:
          type: string
          title: Error Type
        loc:
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
        msg:
          type: string
          title: Message
      required:
      - type
      - loc
      - msg
    QaCheckResultV1:
      properties:
        schema_version:
          type: string
          const: qa_agent_result.v1
          title: Schema Version
        verdict:
          type: string
          enum:
          - passed
          - failed
          - unknown
          title: Verdict
        findings:
          items:
            $ref: '#/components/schemas/QaCheckFindingV1'
          type: array
          title: Findings
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        metadata:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Metadata
        execution_error:
          anyOf:
          - $ref: '#/components/schemas/QaExecutionError'
          - type: 'null'
      additionalProperties: false
      type: object
      required:
      - schema_version
      - verdict
      - findings
      title: QaCheckResultV1
      description: 'The result every QA check yields.


        A check fails on a confirmed problem and otherwise passes; ``unknown`` remains

        for results recorded before ``execution_error``. A check whose input leaves

        nothing to judge passes and names that stage in ``execution_error``. A failure

        a rerun may fix, such as input that did not load or an answer that did not

        parse, ends the run with an error instead of yielding a result.'
x-hud-contract-scope: platform_public