openapi: 3.2.0
info:
  title: Apheris Predict Async API
  version: '2026-09-25'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-25: 9 operation(s) read from 5 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Apheris has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 6
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-25'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.apheris.com/docs/hub/apherisfold-application.html
  - https://www.apheris.com/docs/hub/nim-msa-server-setup.html
  - https://www.apheris.com/docs/hub/troubleshooting.html
  - https://www.apheris.com/docs/hub/external-async-wrapper-kubernetes.html
  - https://www.apheris.com/docs/hub/external-async-wrapper-reference-implementation.html
tags:
- name: Predict Async
paths:
  /api/v1/predict-async:
    post:
      operationId: post_api_v1_predict_async
      tags:
      - Predict Async
      summary: External Async Wrapper Reference Implementation - Apheris Hub Documentation
      x-source: https://www.apheris.com/docs/hub/external-async-wrapper-reference-implementation.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PredictAsyncRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1PredictAsyncResponse'
      x-evidence:
        kind: documentation
  /api/v1/predict-async/{jobid}/{id}:
    get:
      operationId: get_api_v1_predict_async_jobid_id
      tags:
      - Predict Async
      summary: External Async Wrapper Reference Implementation - Apheris Hub Documentation
      x-source: https://www.apheris.com/docs/hub/external-async-wrapper-reference-implementation.html
      parameters:
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PredictAsyncJobidIdResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
components:
  schemas:
    PostApiV1PredictAsyncResponse:
      type: object
      properties:
        jobId:
          type: string
        jobStatus:
          type: string
    GetApiV1PredictAsyncJobidIdResponse:
      type: object
      properties:
        jobId:
          type: string
        jobStatus:
          type: string
        outputPath:
          type: string
        predictions:
          type: array
    PostApiV1PredictAsyncRequest:
      type: object
      properties:
        requestParams:
          type: object
        modelParams:
          type: object
        inputPath:
          type: string
        modelName:
          type: string
        weightVersion:
          type: string
      required:
      - requestParams
      - modelParams
      - inputPath
      - modelName
      - weightVersion