HUD

HUD Imports API

The imports API from HUD — 7 operation(s) for imports.

Documentation GitHub OpenAPI

Operations 8

GET /v2/imports/formats List Import Formats #

POST /v2/imports/uploads Create Import Upload #

GET /v2/imports/estimate Estimate Import #

POST /v2/imports Start Import #

GET /v2/imports List Imports #

GET /v2/imports/{import_id} Get Import #

GET /v2/imports/{import_id}/report Get Import Report #

POST /v2/imports/{import_id}/cancel Cancel Import #

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

openapi: 3.2.0
info:
  title: HUD Platform Imports API
  version: 2.0.0
tags:
- name: Imports
paths:
  /v2/imports/formats:
    get:
      tags:
      - Imports
      summary: List Import Formats
      description: List the bundle formats available to import.
      operationId: list_import_formats_v2_imports_formats_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportFormatListResponse'
        '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/imports/uploads:
    post:
      tags:
      - Imports
      summary: Create Import Upload
      description: Reserve a data file for a bundle and return a presigned PUT to upload its bytes.
      operationId: create_import_upload_v2_imports_uploads_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportUploadRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFileUploadResponse'
        '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/imports/estimate:
    get:
      tags:
      - Imports
      summary: Estimate Import
      description: Estimate an import of a bundle; fails when the bundle cannot be imported.
      operationId: estimate_import_v2_imports_estimate_get
      parameters:
      - name: format
        in: query
        required: true
        schema:
          const: harbor
          type: string
          title: Format
      - name: file_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportEstimateResponse'
        '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/imports:
    post:
      tags:
      - Imports
      summary: Start Import
      description: Import an uploaded bundle into a taskset.
      operationId: start_import_v2_imports_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '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'
    get:
      tags:
      - Imports
      summary: List Imports
      description: 'List the imports the caller can read, newest first.


        Team admins see every import on the team; other members see their own.'
      operationId: list_imports_v2_imports_get
      parameters:
      - name: format
        in: query
        required: false
        schema:
          anyOf:
          - const: harbor
            type: string
          - type: 'null'
          title: Format
      - name: taskset_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Taskset Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportListResponse'
        '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/imports/{import_id}:
    get:
      tags:
      - Imports
      summary: Get Import
      description: Fetch one import.
      operationId: get_import_v2_imports__import_id__get
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '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/imports/{import_id}/report:
    get:
      tags:
      - Imports
      summary: Get Import Report
      description: Return the report a completed or stopped import published, in its format's schema.
      operationId: get_import_report_v2_imports__import_id__report_get
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Import Report V2 Imports  Import Id  Report Get
        '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'
        '413':
          description: Request exceeds a size limit
          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/imports/{import_id}/cancel:
    post:
      tags:
      - Imports
      summary: Cancel Import
      description: Request cancellation of a live import; one that has ended is returned unchanged.
      operationId: cancel_import_v2_imports__import_id__cancel_post
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '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:
    ImportUploadRequest:
      properties:
        filename:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        size_bytes:
          type: integer
          minimum: 0.0
          title: Size Bytes
        content_type:
          type: string
          maxLength: 200
          minLength: 3
          title: Content Type
          default: application/octet-stream
        format:
          type: string
          const: harbor
          title: Format
      type: object
      required:
      - filename
      - size_bytes
      - format
      title: ImportUploadRequest
      description: 'A bundle upload, reserved in the caller''s data folder under the format''s size limit.


        Publish the uploaded file with ``POST /data/{file_id}/complete`` before importing it.'
    ImportFormatListResponse:
      properties:
        formats:
          items:
            $ref: '#/components/schemas/ImportFormatResponse'
          type: array
          title: Formats
      type: object
      required:
      - formats
      title: ImportFormatListResponse
    DataFileUploadResponse:
      properties:
        file:
          $ref: '#/components/schemas/DataFileResponse'
        upload_url:
          type: string
          title: Upload Url
      type: object
      required:
      - file
      - upload_url
      title: DataFileUploadResponse
      description: A reserved data file and the presigned PUT that fills it.
    ImportFile:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        filename:
          type: string
          title: Filename
        size_bytes:
          type: integer
          title: Size Bytes
      type: object
      required:
      - id
      - filename
      - size_bytes
      title: ImportFile
    ImportResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        format:
          type: string
          const: harbor
          title: Format
        taskset_id:
          type: string
          format: uuid
          title: Taskset Id
        file:
          $ref: '#/components/schemas/ImportFile'
          description: The bundle, as it was when the import started
        status:
          type: string
          enum:
          - queued
          - starting
          - running
          - cancelling
          - completed
          - stopped
          - failed
          - cancelled
          title: Status
          description: '`stopped`: the importer refused the bundle or stopped partway, and its report says why; `failed`: the import did not run to an outcome'
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
          description: The importer's account of the outcome; set once completed or stopped
        metrics:
          anyOf:
          - additionalProperties:
              type: number
            type: object
          - type: 'null'
          title: Metrics
          description: Named counts the importer reports, e.g. `tasks_imported`; set with `summary`
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Why a failed import failed
        created_at:
          type: string
          format: date-time
          title: Created At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
          description: Null while the import is live
      type: object
      required:
      - id
      - format
      - taskset_id
      - file
      - status
      - created_at
      title: ImportResponse
    ImportCreateRequest:
      properties:
        format:
          type: string
          const: harbor
          title: Format
        file_id:
          type: string
          format: uuid
          title: File Id
          description: A ready data file holding the bundle
        taskset_id:
          type: string
          format: uuid
          title: Taskset Id
          description: The taskset the bundle is imported into; the caller must be able to edit it
      type: object
      required:
      - format
      - file_id
      - taskset_id
      title: ImportCreateRequest
    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.
    DataFileResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        team_id:
          type: string
          format: uuid
          title: Team Id
        membership_id:
          type: integer
          title: Membership Id
        scope:
          type: string
          enum:
          - member
          - team
          title: Scope
        status:
          type: string
          enum:
          - pending
          - ready
          title: Status
        filename:
          type: string
          title: Filename
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - team_id
      - membership_id
      - scope
      - status
      - filename
      - content_type
      - size_bytes
      - created_at
      - updated_at
      title: DataFileResponse
      description: Size is reserved up front and verified against the stored object on completion.
    ImportFormatResponse:
      properties:
        format:
          type: string
          const: harbor
          title: Format
        title:
          type: string
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        max_input_bytes:
          type: integer
          title: Max Input Bytes
          description: The largest bundle an import of this format takes
      type: object
      required:
      - format
      - title
      - max_input_bytes
      title: ImportFormatResponse
    ImportEstimateResponse:
      properties:
        seconds:
          type: integer
          title: Seconds
        credits:
          type: number
          title: Credits
      type: object
      required:
      - seconds
      - credits
      title: ImportEstimateResponse
      description: Placeholder size-based estimate, pending calibration from run actuals.
    ImportListResponse:
      properties:
        imports:
          items:
            $ref: '#/components/schemas/ImportResponse'
          type: array
          title: Imports
        total:
          type: integer
          title: Total
      type: object
      required:
      - imports
      - total
      title: ImportListResponse
    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).'
    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
x-hud-contract-scope: platform_public