Avala AI, Inc. Inference Providers API

openapi: 3.2.0
info:
  title: Avala Inference Providers 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: inference-providers
paths:
  /inference-providers/:
    parameters: []
    get:
      operationId: inference-providers_list
      summary: CRUD + test for inference provider configurations
      description: 'GET /api/v1/inference-providers/

        POST /api/v1/inference-providers/

        GET /api/v1/inference-providers/{uid}/

        PATCH /api/v1/inference-providers/{uid}/

        DELETE /api/v1/inference-providers/{uid}/

        POST /api/v1/inference-providers/{uid}/test/'
      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/InferenceProviderConfig'
      tags:
      - inference-providers
    post:
      operationId: inference-providers_create
      summary: CRUD + test for inference provider configurations
      description: 'GET /api/v1/inference-providers/

        POST /api/v1/inference-providers/

        GET /api/v1/inference-providers/{uid}/

        PATCH /api/v1/inference-providers/{uid}/

        DELETE /api/v1/inference-providers/{uid}/

        POST /api/v1/inference-providers/{uid}/test/'
      requestBody:
        $ref: '#/components/requestBodies/InferenceProviderConfigCreate'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceProviderConfigCreate'
      tags:
      - inference-providers
  /inference-providers/{uid}/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: inference-providers_read
      summary: CRUD + test for inference provider configurations
      description: 'GET /api/v1/inference-providers/

        POST /api/v1/inference-providers/

        GET /api/v1/inference-providers/{uid}/

        PATCH /api/v1/inference-providers/{uid}/

        DELETE /api/v1/inference-providers/{uid}/

        POST /api/v1/inference-providers/{uid}/test/'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceProviderConfig'
      tags:
      - inference-providers
    patch:
      operationId: inference-providers_partial_update
      summary: CRUD + test for inference provider configurations
      description: 'GET /api/v1/inference-providers/

        POST /api/v1/inference-providers/

        GET /api/v1/inference-providers/{uid}/

        PATCH /api/v1/inference-providers/{uid}/

        DELETE /api/v1/inference-providers/{uid}/

        POST /api/v1/inference-providers/{uid}/test/'
      requestBody:
        $ref: '#/components/requestBodies/InferenceProviderConfigCreate'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceProviderConfigCreate'
      tags:
      - inference-providers
    delete:
      operationId: inference-providers_delete
      summary: CRUD + test for inference provider configurations
      description: 'GET /api/v1/inference-providers/

        POST /api/v1/inference-providers/

        GET /api/v1/inference-providers/{uid}/

        PATCH /api/v1/inference-providers/{uid}/

        DELETE /api/v1/inference-providers/{uid}/

        POST /api/v1/inference-providers/{uid}/test/'
      responses:
        '204':
          description: ''
      tags:
      - inference-providers
  /inference-providers/{uid}/test/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: inference-providers_test_connection
      description: Test connectivity to the configured inference endpoint.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InferenceProviderConfig'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceProviderConfig'
      tags:
      - inference-providers
      summary: Inference providers test connection
      x-summary-source: derived
components:
  schemas:
    InferenceProviderConfig:
      required:
      - name
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          description: Human-readable name, e.g. 'My YOLO v8 endpoint'.
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
        provider_type:
          title: Provider type
          type: string
          enum:
          - sagemaker
          - http
        config:
          title: Config
          description: 'Provider-specific configuration. For HTTP: endpoint_url (required), auth_header, auth_type, headers, timeout, response_key. For SageMaker: endpoint_name, region.'
          type: object
        is_active:
          title: Is active
          type: boolean
        project:
          title: Project
          description: If set, this provider is only available in this project.
          type:
          - integer
          - 'null'
        last_test_at:
          title: Last test at
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        last_test_success:
          title: Last test success
          type:
          - boolean
          - 'null'
          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
    InferenceProviderConfigCreate:
      required:
      - name
      type: object
      properties:
        name:
          title: Name
          description: Human-readable name, e.g. 'My YOLO v8 endpoint'.
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
        provider_type:
          title: Provider type
          type: string
          enum:
          - sagemaker
          - http
        config:
          title: Config
          description: 'Provider-specific configuration. For HTTP: endpoint_url (required), auth_header, auth_type, headers, timeout, response_key. For SageMaker: endpoint_name, region.'
          type: object
        is_active:
          title: Is active
          type: boolean
        project:
          title: Project
          description: If set, this provider is only available in this project.
          type:
          - integer
          - 'null'
  requestBodies:
    InferenceProviderConfigCreate:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InferenceProviderConfigCreate'
      required: true
  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.