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

# models.list(): the platform models, then the project models



## OpenAPI

````yaml /api-reference/openapi.json get /models
openapi: 3.1.0
info:
  title: paddock API
  version: 1.0.0
  description: >-
    The paddock API. Send an API key, or a session token on its own session, as
    a bearer token.
servers:
  - url: https://api.paddock.build/v1
security:
  - bearer: []
paths:
  /models:
    get:
      summary: 'models.list(): the platform models, then the project models'
      operationId: listModels
      responses:
        '200':
          description: Every model the project can use, in one page
          headers:
            Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPage'
        default:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request's ID, for support and logs
      schema:
        type: string
  schemas:
    ModelPage:
      allOf:
        - $ref: '#/components/schemas/Page'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Model'
    Page:
      description: >-
        Every resource list returns one page: a cursor-paged slice of items.
        Typed pages extend it.
      type: object
      required:
        - data
        - nextCursor
      properties:
        data:
          type: array
        nextCursor:
          type:
            - string
            - 'null'
    Model:
      description: >-
        A model the project can use: a platform model of paddock's catalog, or a
        project model of one of its providers.
      type: object
      required:
        - name
        - harness
        - source
        - provider
      properties:
        name:
          description: What a template's or an agent's model names.
          type: string
        harness:
          $ref: '#/components/schemas/Harness'
        source:
          type: string
          enum:
            - platform
            - project
        provider:
          description: The project model's provider; null for a platform model.
          type:
            - string
            - 'null'
    ErrorBody:
      description: The body of every non-2xx response.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    Harness:
      type: string
      enum:
        - claude-code
        - codex
        - pi
    ErrorObject:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
        details:
          type: object
    ErrorCode:
      type: string
      enum:
        - invalid_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - payload_too_large
        - unsupported
        - unavailable
        - internal
  responses:
    Error:
      description: Every non-2xx response
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key, or a session token on its own session

````

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