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

# List Models

> List all models in the current organization.

This endpoint uses cursor-based pagination ordered newest-first. See [Pagination](/api-reference/pagination) for a full example.


## OpenAPI

````yaml /openapi.json get /models
openapi: 3.1.0
info:
  title: Woodwide API
  description: API service for the Woodwide platform
  version: 0.1.0
servers:
  - url: https://api.woodwide.ai
    description: Production
security: []
paths:
  /models:
    get:
      tags:
        - Models
      summary: List Models
      description: List all models in the current organization.
      operationId: list_models_models_get
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Case-insensitive substring search on model name. Returns models
              whose name contains the query string.
            title: Q
          description: >-
            Case-insensitive substring search on model name. Returns models
            whose name contains the query string.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Pagination cursor
            title: Cursor
          description: Pagination cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelsResponse'
              example:
                next_cursor: null
                items:
                  - model_id: b2c3d4e5-0000-0000-0000-000000000001
                    model_type: prediction
                    status: ready
                    current_metrics:
                      accuracy: 0.98
                    current_version:
                      version_id: b2c3d4e5-0000-0000-0000-000000000002
                      version: 1
                      status: ready
                      metrics:
                        accuracy: 0.98
                    training_dataset_id: a1b2c3d4-0000-0000-0000-000000000001
                    training_dataset_name: retention_customers
                    label_column: churnReason
                    created_at: '2025-01-15T11:00:00Z'
                    updated_at: '2025-01-15T11:05:00Z'
        '401':
          description: Unauthorized -- API key is missing or invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Not authenticated
        '403':
          description: >-
            Forbidden -- your API key does not have permission for this
            resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Forbidden
        '404':
          description: Not Found -- the requested resource does not exist.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Too Many Requests -- you have exceeded the rate limit. Heavy
            operations (training, inference, dataset uploads) are limited to 60
            requests per minute per API key. All other endpoints are limited to
            600 requests per minute per API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Rate limit exceeded. Retry after a short delay.
      security:
        - HTTPBearer: []
components:
  schemas:
    ListModelsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Model'
          type: array
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - items
      title: ListModelsResponse
      description: |-
        Response for listing models.

        Returns models in the current organization. Each model's ``status``
        field reflects the latest version: ``ready``, ``processing``, or
        ``failed``.
      example:
        next_cursor: null
        items:
          - model_id: b2c3d4e5-0000-0000-0000-000000000001
            model_type: prediction
            status: ready
            current_metrics:
              accuracy: 0.98
            current_version:
              version_id: b2c3d4e5-0000-0000-0000-000000000002
              version: 1
              status: ready
              metrics:
                accuracy: 0.98
            training_dataset_id: a1b2c3d4-0000-0000-0000-000000000001
            training_dataset_name: retention_customers
            label_column: churnReason
            created_at: '2025-01-15T11:00:00Z'
            updated_at: '2025-01-15T11:05:00Z'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      description: Returned when request parameters or body fail validation.
    Model:
      properties:
        model_id:
          type: string
          format: uuid
          title: Model Id
        model_type:
          $ref: '#/components/schemas/ModelType'
        status:
          type: string
          title: Status
          description: 'Aggregated from the current version: ready, processing, or failed.'
          default: processing
        current_metrics:
          anyOf:
            - additionalProperties:
                anyOf:
                  - type: number
                  - type: integer
              type: object
            - type: 'null'
          title: Current Metrics
          description: >-
            Validation metrics from the current (latest) version, promoted for
            convenience. Keys depend on model type: **prediction
            (classification):** `accuracy` (0–1). **prediction (regression):**
            `r2` (R-squared). **clustering:** `n_clusters`, `silhouette_score`
            (−1 to 1). Other model types do not produce metrics.
        current_version:
          anyOf:
            - $ref: >-
                #/components/schemas/woodwide__api__routers__models__schemas__CurrentVersion
            - type: 'null'
        training_dataset_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Training Dataset Id
          description: Dataset used to train the current version (if known).
        training_dataset_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Training Dataset Name
          description: Display name of the training dataset for the current version.
        label_column:
          anyOf:
            - type: string
            - type: 'null'
          title: Label Column
          description: >-
            Target column used to train the current version (prediction models
            only). Omitted for other model types.
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - model_id
        - model_type
        - created_at
        - updated_at
      title: Model
      description: Model response model.
    ValidationError:
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            type: string
          title: Location
          description: Path to the field that caused the error.
        msg:
          type: string
          title: Message
          description: Human-readable error message.
        type:
          type: string
          title: Error Type
          description: Machine-readable error type identifier.
      title: ValidationError
    ModelType:
      type: string
      enum:
        - prediction
        - anomaly
        - embedding
        - clustering
        - factors
        - search
      title: ModelType
      description: |-
        Canonical model types supported by the platform.

        - ``prediction`` -- Supervised prediction (classification or regression)
          on a target column.
        - ``anomaly`` -- Unsupervised anomaly detection. Returns anomaly scores
          and anomalous row IDs.
        - ``embedding`` -- Generate dense vector embeddings for each row.
        - ``clustering`` -- Unsupervised clustering. Returns cluster labels and
          descriptions.
        - ``factors`` -- Factor analysis / dimensionality reduction.
        - ``search`` -- Semantic nearest-neighbor search over the training
          dataset.
    woodwide__api__routers__models__schemas__CurrentVersion:
      properties:
        version_id:
          type: string
          format: uuid
          title: Version Id
        version:
          type: integer
          title: Version
        status:
          $ref: '#/components/schemas/ModelVersionStatus'
          description: Version status.
        metrics:
          anyOf:
            - additionalProperties:
                anyOf:
                  - type: number
                  - type: integer
              type: object
            - type: 'null'
          title: Metrics
          description: >-
            Validation metrics from the current version's training run. Keys
            depend on model type: **prediction (classification):** `accuracy`
            (0–1). **prediction (regression):** `r2` (R-squared).
            **clustering:** `n_clusters`, `silhouette_score` (−1 to 1). Other
            model types do not produce metrics.
      type: object
      required:
        - version_id
        - version
        - status
      title: CurrentVersion
      description: Current version summary embedded in the Model response.
    ModelVersionStatus:
      type: string
      enum:
        - queued
        - training
        - ready
        - failed
      title: ModelVersionStatus
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````