Super.ai Models API

openapi: 3.2.0
info:
  title: SuperAI Flow Platform Models API
  description: SuperAI Flows is a workflow orchestration platform that enables you to design, deploy, and monitor automated workflows at scale.
  version: 0.1.0
tags:
- name: Models
  description: Model operations for querying available AI models and their configurations.
  x-displayName: Models
paths:
  /api/models:
    get:
      tags:
      - Models
      summary: List available models
      description: 'Retrieve a list of available AI models, deduplicated by model name and optionally filtered by region.


        Each model entry aggregates information from all available endpoints:

        - **regions**: All regions where this model is deployed

        - **locations**: All specific locations (e.g., westeurope, eastus)

        - **providers**: All providers offering this model

        - **endpoint_count**: Total number of endpoints available


        Use the `region` parameter to filter models by deployment region:

        - `eu`: Only models with at least one EU endpoint

        - `global`: Only models with at least one global/US endpoint


        If no region is specified, all models are returned.'
      operationId: get_models_api_models_get
      parameters:
      - name: region
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/Region'
          - type: 'null'
          description: Filter models by region. If not specified, returns all models.
          title: Region
        description: Filter models by region. If not specified, returns all models.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
      - APIKeyAuth: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ModelInfo:
      properties:
        model_name:
          type: string
          title: Model Name
          description: Name of the model
        regions:
          items:
            $ref: '#/components/schemas/Region'
          type: array
          title: Regions
          description: Regions where the model is deployed
        locations:
          items:
            type: string
          type: array
          title: Locations
          description: Specific locations where the model is available
        providers:
          items:
            type: string
          type: array
          title: Providers
          description: Model providers (e.g., 'openai', 'vertex_ai', 'fireworks')
        endpoint_count:
          type: integer
          title: Endpoint Count
          description: Number of endpoints available for this model
        supports_bounding_boxes:
          type: boolean
          title: Supports Bounding Boxes
          description: Whether the model supports bounding box output
        supports_confidence_scores:
          type: boolean
          title: Supports Confidence Scores
          description: Whether the model supports confidence scores via logprobs
      type: object
      required:
      - model_name
      - regions
      - locations
      - providers
      - endpoint_count
      - supports_bounding_boxes
      - supports_confidence_scores
      title: ModelInfo
      description: Model information from LiteLLM.
    ModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/ModelInfo'
          type: array
          title: Models
          description: List of available models
        count:
          type: integer
          title: Count
          description: Total number of models
      type: object
      required:
      - models
      - count
      title: ModelsResponse
      description: Response containing list of models.
    Region:
      type: string
      enum:
      - eu
      - global
      title: Region
      description: Available regions for model deployment.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT Bearer token authentication. Include your access token in the Authorization header as: `Bearer YOUR_ACCESS_TOKEN`


        Example:

        ```

        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

        ```'
    APIKeyAuth:
      type: apiKey
      name: X-API-Key
      in: header
      description: 'API key authentication. Include your API key in the X-API-Key header as: `X-API-Key YOUR_API_KEY`


        Example:

        ```

        X-API-Key: saf_1234567890

        ```'