> ## 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.

# modelProviders.list(): the project's model providers, by name



## OpenAPI

````yaml /api-reference/openapi.json get /model-providers
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:
  /model-providers:
    get:
      summary: 'modelProviders.list(): the project''s model providers, by name'
      operationId: listModelProviders
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of model providers
          headers:
            Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderPage'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Page size
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The nextCursor of the previous page
      schema:
        type: string
  headers:
    RequestId:
      description: The request's ID, for support and logs
      schema:
        type: string
  schemas:
    ModelProviderPage:
      allOf:
        - $ref: '#/components/schemas/Page'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/ModelProvider'
    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'
    ModelProvider:
      type: object
      required:
        - name
        - kind
        - protocol
        - harness
        - baseUrl
        - keyPreview
        - models
        - status
        - lastError
        - checkedAt
        - createdAt
        - updatedAt
      properties:
        name:
          description: >-
            Unique in the project, fixed at creation; a project model is named
            provider/model.
          type: string
          pattern: ^[a-z0-9-]{1,32}$
        kind:
          $ref: '#/components/schemas/ProviderKind'
        protocol:
          $ref: '#/components/schemas/ModelProtocol'
        harness:
          $ref: '#/components/schemas/Harness'
        baseUrl:
          type: string
        keyPreview:
          description: The key's first 4 and last 4 characters; the key is never returned.
          type: string
        models:
          type: array
          items:
            $ref: '#/components/schemas/ProviderModel'
        status:
          type: string
          enum:
            - ok
            - failing
        lastError:
          description: 'While failing: what the provider answered.'
          type:
            - string
            - 'null'
        checkedAt:
          $ref: '#/components/schemas/Timestamp'
        createdAt:
          $ref: '#/components/schemas/Timestamp'
        updatedAt:
          $ref: '#/components/schemas/Timestamp'
    ErrorBody:
      description: The body of every non-2xx response.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    ProviderKind:
      type: string
      enum:
        - anthropic
        - openai
        - anthropic-compatible
        - openai-compatible
    ModelProtocol:
      description: >-
        anthropic: the Messages API, which Claude Code speaks; openai: the
        Responses API, which Codex speaks.
      type: string
      enum:
        - anthropic
        - openai
    Harness:
      type: string
      enum:
        - claude-code
        - codex
        - pi
    ProviderModel:
      type: object
      required:
        - id
        - name
        - protocol
      properties:
        id:
          description: The provider's model ID, sent upstream as it is.
          type: string
        name:
          description: 'provider/id: the name a template, an agent, and a request use.'
          type: string
        protocol:
          $ref: '#/components/schemas/ModelProtocol'
    Timestamp:
      description: RFC 3339 in UTC with milliseconds.
      type: string
      format: date-time
      pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
      x-go-type: wire.Timestamp
      x-go-type-import:
        path: github.com/wenfengwang/paddock/internal/wire
    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.