> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List ML models

> List all ML models available for the authenticated user's company.



## OpenAPI

````yaml /api-reference/openapi-v3-instance.yaml get /api/v3/instance/models
openapi: 3.1.0
info:
  title: LightOn API
  version: 3.15.0 (v3-instance)
  description: >-
    LightOn gives you an API to search, parse, and ingest documents at scale.
    Build knowledge-retrieval pipelines without managing vector databases or OCR
    models.
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Models
    description: Operations about AI models
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
paths:
  /api/v3/instance/models:
    get:
      tags:
        - Models
      summary: List ML models
      description: List all ML models available for the authenticated user's company.
      operationId: api_v3_instance_models_list
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MLModel'
          description: ''
        '503':
          description: >-
            API is under maintenance. Check `GET /api/v3/system/status` for
            active periods and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceMaintenance503'
      security:
        - bearerAuth: []
components:
  schemas:
    MLModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID for this model
        name:
          type: string
          description: Display name for this MLModel
        technical_name:
          type: string
          description: >-
            Instance-wide unique technical name for this model such as it is set
            in the mode gateway configuration
        model_type:
          allOf:
            - $ref: '#/components/schemas/ModelTypeEnum'
          description: >-
            Type of model (eg. 'Large Language Model', 'Embedding Model','Vision
            Language Model', 'Multi-Vector Model)


            * `Large Language Model` - Large Language Model

            * `Embedding Model` - Embedding Model

            * `Vision Language Model` - Vision Language Model

            * `Multi-Vector Model` - Multi-Vector Model
        litellm_model:
          type:
            - string
            - 'null'
          description: >-
            Underlying gateway routing string (e.g. `anthropic/claude-opus-5`).
            Its provider prefix is what identifies which provider serves the
            model; absent when the gateway does not report one.
        enabled:
          type: boolean
          description: Wether or not this model is enabled instance-wide.
        is_default:
          type: boolean
          description: Wether or not this is the platform-wide default generation model.
        is_default_for_company:
          type: boolean
          description: Wether or not this model is set as default for this company.
        health:
          allOf:
            - $ref: '#/components/schemas/MLModelHealth'
          description: Health status of the model
        source:
          allOf:
            - $ref: '#/components/schemas/SourceEnum'
          default: managed
          description: >-
            Whether the model is managed by the platform ('managed') or
            registered by the company ('custom').


            * `managed` - managed

            * `custom` - custom
        linked_aliases:
          type: array
          items:
            $ref: '#/components/schemas/MLModelToAliasMapping'
          description: Aliases linked to this model
      required:
        - enabled
        - health
        - id
        - is_default
        - is_default_for_company
        - linked_aliases
        - model_type
        - name
        - technical_name
    ServiceMaintenance503:
      type: object
      description: >-
        Returned by the maintenance middleware when the requested endpoint is
        blocked.
      required:
        - detail
        - error
        - mode
      properties:
        detail:
          type: string
          example: System is under maintenance.
        error:
          type: string
          example: service_maintenance
        mode:
          type: string
          enum:
            - full_shutdown
            - warning_banner
          description: >-
            `full_shutdown` blocks all traffic; `warning_banner` also blocks and
            shows a dismissible toast.
        reason:
          type: string
          description: Operator-supplied maintenance reason, if any.
        started_at:
          type: string
          format: date-time
        endpoint_category_names:
          type: array
          items:
            type: string
          description: >-
            Non-empty only for category-scoped periods. Empty means all
            endpoints are affected.
    ModelTypeEnum:
      enum:
        - Large Language Model
        - Embedding Model
        - Vision Language Model
        - Multi-Vector Model
      type: string
      description: |-
        * `Large Language Model` - Large Language Model
        * `Embedding Model` - Embedding Model
        * `Vision Language Model` - Vision Language Model
        * `Multi-Vector Model` - Multi-Vector Model
    MLModelHealth:
      type: object
      properties:
        status:
          allOf:
            - $ref: '#/components/schemas/MLModelHealthStatusEnum'
          description: >-
            Health status of the model as of the last periodic healthcheck:
            'healthy', 'unhealthy', or 'unknown' when the model has never been
            checked. Never triggers a check.


            * `healthy` - healthy

            * `unhealthy` - unhealthy

            * `unknown` - unknown
        is_healthy:
          type: boolean
          description: >-
            Whether the model is considered usable for routing. Optimistic: true
            for a model that has never been checked. Read status to tell
            'healthy' apart from 'unknown'.
        last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp of the last health check, or null when the model has never
            been checked
      required:
        - is_healthy
        - last_checked_at
        - status
    SourceEnum:
      enum:
        - managed
        - custom
      type: string
      description: |-
        * `managed` - managed
        * `custom` - custom
    MLModelToAliasMapping:
      type: object
      properties:
        alias_id:
          type: string
          format: uuid
          description: ID of the alias
        alias_name:
          type: string
          description: Name of the alias
        alias_technical_name:
          type: string
          description: Company-wide unique technical name for this model alias
      required:
        - alias_id
        - alias_name
        - alias_technical_name
    MLModelHealthStatusEnum:
      enum:
        - healthy
        - unhealthy
        - unknown
      type: string
      description: |-
        * `healthy` - healthy
        * `unhealthy` - unhealthy
        * `unknown` - unknown
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````