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

# List Models

> The model catalog: every model Mixpeek runs or can run, with its task, input and output schema, extractor and retriever wiring, run status, scale-to-zero profile, cost, evaluation evidence, references and the namespace templates that use it. Filter by task, modality, status, license, commercial use, GPU need, template or use case; search with q; sort by rank (default), name, release_date, params, size, dims or templates. No authentication required.



## OpenAPI

````yaml get /v1/discovery/models
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/discovery/models:
    get:
      tags:
        - Discovery
      summary: List Models
      description: >-
        The model catalog: every model Mixpeek runs or can run, with its task,
        input and output schema, extractor and retriever wiring, run status,
        scale-to-zero profile, cost, evaluation evidence, references and the
        namespace templates that use it. Filter by task, modality, status,
        license, commercial use, GPU need, template or use case; search with q;
        sort by rank (default), name, release_date, params, size, dims or
        templates. No authentication required.
      operationId: list_models_v1_discovery_models_get
      parameters:
        - name: task
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Task category, e.g. embedding, detection, transcription
            title: Task
          description: Task category, e.g. embedding, detection, transcription
        - name: modality
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Input or output modality, e.g. image, video, text
            title: Modality
          description: Input or output modality, e.g. image, video, text
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Run status: served, extractor, api, plugin or not_runnable'
            title: Status
          description: 'Run status: served, extractor, api, plugin or not_runnable'
        - name: commercial_use
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Only models whose license allows commercial use (true) or not
            title: Commercial Use
          description: Only models whose license allows commercial use (true) or not
        - name: license
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: License id, e.g. apache-2.0
            title: License
          description: License id, e.g. apache-2.0
        - name: gpu
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: 'true: needs a GPU. false: runs without one'
            title: Gpu
          description: 'true: needs a GPU. false: runs without one'
        - name: template
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only models a namespace template uses (template slug)
            title: Template
          description: Only models a namespace template uses (template slug)
        - name: use_case
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Use case tag
            title: Use Case
          description: Use case tag
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Words that must all appear in the model's text fields
            title: Q
          description: Words that must all appear in the model's text fields
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: rank, name, release_date, params, size, dims or templates
            default: rank
            title: Sort
          description: rank, name, release_date, params, size, dims or templates
        - name: order
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^(asc|desc)$
              - type: 'null'
            description: asc or desc; each sort has a default
            title: Order
          description: asc or desc; each sort has a default
        - name: view
          in: query
          required: false
          schema:
            type: string
            pattern: ^(full|compact)$
            description: full records or compact index lines
            default: full
            title: View
          description: full records or compact index lines
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Page size
            default: 100
            title: Limit
          description: Page size
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Records to skip
            default: 0
            title: Offset
          description: Records to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelCatalogListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    ModelCatalogListResponse:
      properties:
        total:
          type: integer
          title: Total
          description: Records that match the filters
        count:
          type: integer
          title: Count
          description: Records in this page
        offset:
          type: integer
          title: Offset
          description: Index of the first record in this page
        limit:
          type: integer
          title: Limit
          description: Page size requested
        sort:
          type: string
          title: Sort
          description: Sort key applied
        order:
          type: string
          title: Order
          description: asc or desc
        view:
          type: string
          title: View
          description: full (whole records) or compact (index lines)
        facets:
          additionalProperties:
            additionalProperties:
              type: integer
            type: object
          type: object
          title: Facets
          description: >-
            Counts per value over the matching records, for each filterable
            field: status, category, modalities_in, modalities_out, license,
            commercial_use, use_cases, gpu and templates
        models:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Models
          description: >-
            Model records: identity, task, input and output schema, how the
            model is wired into extractors and retriever stages, how it runs
            (status, weights, scale to zero), cost, evaluation evidence,
            references (hf://, mixpeek://, github://, api://, url://), the
            templates that use it, usage, rank and flat facets
        rank_formula:
          anyOf:
            - type: string
            - type: 'null'
          title: Rank Formula
          description: How rank_score is computed
      type: object
      required:
        - total
        - count
        - offset
        - limit
        - sort
        - order
        - view
      title: ModelCatalogListResponse
      description: A filtered, sorted page of the model catalog.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.