---
title: "GET /api/v1/analyze/ml-model/list/"
method: GET
path: "/api/v1/analyze/ml-model/list/"
tags: ["analyze", "v1"]
---

# GET /api/v1/analyze/ml-model/list/

`GET /api/v1/analyze/ml-model/list/`

MLModel List

## Query parameters

- `jq_filters` object

## Response `200`

- MLModel[]
  - `id` integer
  - `name` string, required — Model name, may include module parameters
  - `version` string, required — Model version
  - `vector_name` string, nullable
  - `model_path` string, required — Model path, relative to WebDAV root folder
  - `is_active` boolean — Inactive models are ignored
  - `default` boolean — The default model is used unless another model is deliberately selected
  - `apply_to` 'document' | 'text_unit', nullable, required — Should the model be applied to documents or text units
  - `target_entity` 'transformer' | 'classifier' | 'contract_type_classifier' | 'is_contract', nullable, required — The model class
  - `language` string, nullable, required — Language (ISO 693-1) code, may be omitted
  - `text_unit_type` 'sentence' | 'paragraph', nullable — Text unit type: sentence or paragraph
  - `codebase_version` string, nullable — ContraxSuite version in which the model was created
  - `user_modified` boolean — User modified models are not automatically updated
  - `project` integer, nullable — Optional project reference

## Changes

> 5 revisions in range; 1 could not be searched.

- **2021-09-22** `63116f2e9e3e` — 1 warning, 2 info
  - added the new `is_contract` enum value to the `items/target_entity` response property for the response status `200`
  - added the optional property `items/codebase_version` to the response with the `200` status
  - added the optional property `items/user_modified` to the response with the `200` status
- **2021-05-24** `8167164be9cc` — 1 info
  - endpoint added
- **2020-12-11** `0957c4a7ae3d` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/analyze/ml-model/list/get.md)

---

[API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.dev/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/revisions/3429f921b4cb/schema)