---
title: "PATCH /models/{modelId}"
method: PATCH
path: "/models/{modelId}"
---

# PATCH /models/{modelId}

`PATCH /models/{modelId}`

## Path parameters

- `modelId` string, required

## Headers

- `Content-Type` string, required

## Request body

- PatchModelId
  - `description` string, nullable
  - `fieldConfig` object
  - `height` integer
  - `name` string, nullable
  - `preprocessConfig` object
    - `autoRotate` boolean, required
    - `imageQuality` 'LOW' | 'HIGH', required
    - `maxPages` integer, required
  - `width` integer

## Response `200`

200 response

- Model
  - `createdBy` string, nullable, required
  - `createdTime` string, nullable, required
  - `description` string, nullable, required
  - `fieldConfig` object, required
  - `height` integer, required
  - `modelId` string, required
  - `name` string, nullable, required
  - `numberOfDataBundles` integer, required
  - `numberOfRunningTrainings` integer, required
  - `preprocessConfig` object, required
    - `autoRotate` boolean, required
    - `imageQuality` 'LOW' | 'HIGH', required
    - `maxPages` integer, required
  - `status` 'active' | 'inactive', required
  - `updatedBy` string, nullable, required
  - `updatedTime` string, nullable, required
  - `width` integer, required

## Other responses

- `400` — 400 response
- `403` — 403 response
- `404` — 404 response
- `415` — 415 response
- `500` — 500 response

## Changes

- **2021-12-10** `c3dbcad72582` — 1 warning, 2 info
  - removed the request property `status`
  - removed the `training` enum value from the `status` response property for the response status `200`
  - added the required property `numberOfRunningTrainings` to the response with the `200` status
- **2021-11-05** `9788e6bfa925` — 9 breaking, 13 warning, 10 info
  - the request property `preprocessConfig/autoRotate` became required
  - the request property `preprocessConfig/imageQuality` became required
  - the request property `preprocessConfig/maxPages` became required
  - the `preprocessConfig/maxPages` request property's max was decreased to `3.00`
  - …28 more

[Change history](https://skmtc.dev/lucidtechai/apis/lucidtech-api/changes/models/:modelId/patch.md)

---

[API](https://skmtc.dev/lucidtechai/apis/lucidtech-api.md) · [All operations](https://skmtc.dev/lucidtechai/apis/lucidtech-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lucidtechai/lucidtech-api/revisions/79adeefb69f1/schema)