Avala AI, Inc. Models API

openapi: 3.2.0
info:
  title: Avala Models API
  description: '# Authentication


    ## Generating an API Key


    The Avala SDK uses API keys to authenticate requests. You can create and manage your API keys from the

    Settings page of Mission Control.


    Follow these steps to generate a new API key:


    1. Open your settings page by clicking on your user avatar located at the top right-hand corner of any

    Mission Control screen, and select `Settings`.

    2. From the left-hand sub-menu, select `Security & Identity`.

    3. Click on `New API Key`, enter a name for the key, and then click `Create key`.


    The new key will be automatically copied to your clipboard. Please note, for security reasons, the key

    will not be accessible once you close the window. Ensure you store it in a safe location before closing

    the pop-up modal.


    ### Video walkthrough of API key generation


    ## Authenticating with an API Key


    This is the easiest part! Just add a header named `X-Avala-Api-Key` to your requests and set the

    previously generated API Key as the value.'
  termsOfService: https://avala.ai/legal/terms
  contact:
    email: support@avala.ai
  version: v1
servers:
- url: https://api.avala.ai/api/v1
security:
- API_Key: []
- JWT: []
tags:
- name: Models
paths:
  /models/:
    parameters: []
    get:
      operationId: models_list
      description: ''
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: order
        in: query
        description: Sets the CursorPagination `offset` when `cursor` is also set. e.g. `cursor=...&offset=1`
        schema:
          type: string
      - name: reverse
        in: query
        description: Sets the CursorPagination `reverse` when `cursor` is also set. e.g. `cursor=...&reverse=1`.
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Model'
      tags:
      - Models
      summary: Models list
      x-summary-source: derived
  /models/integrations/{integration_uid}/predict/:
    parameters:
    - name: integration_uid
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: models_integrations_predict_create
      description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ModelRunCreationItem'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModelRun'
      tags:
      - Models
      summary: Models integrations predict create
      x-summary-source: derived
  /models/runs/:
    parameters: []
    get:
      operationId: models_runs_list
      description: ''
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: integration_uid
        in: query
        schema:
          type: string
      - name: dataset_item_uid
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelRun'
      tags:
      - Models
      summary: Models runs list
      x-summary-source: derived
  /models/runs/{uid}/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: models_runs_read
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRun'
      tags:
      - Models
      summary: Models runs read
      x-summary-source: derived
  /models/runs/{uid}/predictions/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: models_runs_predictions_list
      description: ''
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: dataset_uid
        in: query
        schema:
          type: string
      - name: dataset_item_uid
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModelPrediction'
      tags:
      - Models
      summary: Models runs predictions list
      x-summary-source: derived
  /models/{model_uid}/integrations/:
    parameters:
    - name: model_uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: models_integrations_list
      description: ''
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: order
        in: query
        description: Sets the CursorPagination `offset` when `cursor` is also set. e.g. `cursor=...&offset=1`
        schema:
          type: string
      - name: reverse
        in: query
        description: Sets the CursorPagination `reverse` when `cursor` is also set. e.g. `cursor=...&reverse=1`.
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelProviderConfig'
      tags:
      - Models
      summary: Models integrations list
      x-summary-source: derived
components:
  schemas:
    ModelPrediction:
      required:
      - dataset_uid
      - dataset_item_uid
      type: object
      properties:
        dataset_uid:
          title: Dataset uid
          type: string
          minLength: 1
        dataset_item_uid:
          title: Dataset item uid
          type: string
          minLength: 1
        predictions:
          $ref: '#/components/schemas/ModelPredictionDatasetItemAnnotationList'
    ModelRunCreationItem:
      required:
      - dataset_uid
      type: object
      properties:
        dataset_uid:
          title: Dataset uid
          type: string
          format: uuid
        dataset_item_uids:
          type: array
          items:
            type: string
            format: uuid
        integration_uid:
          title: Integration uid
          type: string
          format: uuid
          readOnly: true
    Model:
      required:
      - name
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 100
          minLength: 1
        description:
          title: Description
          type:
          - string
          - 'null'
          maxLength: 1024
        model_type_name:
          title: Model type name
          type: string
          readOnly: true
          minLength: 1
        model_type_description:
          title: Model type description
          type: string
          readOnly: true
          minLength: 1
        is_public:
          title: Is public
          type: boolean
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    DatasetItemAnnotationNode:
      required:
      - annotation_info
      - status
      - uid
      - project_index
      - children
      type: object
      properties:
        annotation_info:
          $ref: '#/components/schemas/DatasetItemAnnotation'
        status:
          title: Status
          type: string
          minLength: 1
        uid:
          title: Uid
          type: string
          minLength: 1
        project_index:
          title: Project index
          type:
          - integer
          - 'null'
        annotator:
          $ref: '#/components/schemas/AnnotationUser'
        reviewer:
          $ref: '#/components/schemas/AnnotationUser'
        children:
          type: array
          items:
            $ref: '#/components/schemas/DatasetItemAnnotationNode'
    ModelPredictionDatasetItemAnnotationList:
      required:
      - nodes
      type: object
      properties:
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/DatasetItemAnnotationNode'
    AnnotationUser:
      required:
      - username
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        full_name:
          title: Full name
          type: string
          readOnly: true
        username:
          title: Username
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          type: string
          pattern: ^[\w.@+-]+$
          maxLength: 150
          minLength: 1
        picture:
          title: Picture
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2048
    ModelProviderConfig:
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        provider_name:
          title: Provider name
          type: string
          readOnly: true
          minLength: 1
        provider_config_type:
          title: Provider config type
          type: string
          readOnly: true
          minLength: 1
        provider_config_uid:
          title: Provider config uid
          type: string
          format: uuid
          readOnly: true
        provider_config_name:
          title: Provider config name
          type: string
          readOnly: true
          minLength: 1
    ModelRun:
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        run_status:
          title: Run status
          type: string
          readOnly: true
        type:
          title: Type
          type: string
          readOnly: true
        integration_uid:
          title: Integration uid
          type: string
          format: uuid
          readOnly: true
        dataset:
          type: array
          items:
            $ref: '#/components/schemas/SwaggerDocDataset'
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    DatasetItemAnnotation:
      required:
      - task_name
      - task_object
      - object_uuid
      type: object
      properties:
        task_name:
          title: Task name
          type: string
          minLength: 1
        task_object:
          title: Task object
          type: string
          minLength: 1
        object_uuid:
          title: Object uuid
          type:
          - string
          - 'null'
          minLength: 1
        data:
          title: Data
          type: object
          readOnly: true
    SwaggerDocDataset:
      required:
      - dataset_uid
      - dataset_item_uids
      type: object
      properties:
        dataset_uid:
          title: Dataset uid
          type: string
          format: uuid
        dataset_item_uids:
          type: array
          items:
            type: string
            format: uuid
  securitySchemes:
    JWT:
      type: apiKey
      name: Authorization
      in: header
      description: JWT token with 'JWT' prefix, e.g., 'JWT eyJhbGciOiJIUzI1NiIsInR...'
    API_Key:
      type: apiKey
      name: X-Avala-Api-Key
      in: header
      description: API key for authentication. Generate one in Mission Control Settings > Security & Identity.