---
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
  - `metadata` object
  - `name` string, nullable
  - `postprocessConfig` union
    - object
      - `strategy` 'BEST_FIRST', required
    - object
      - `parameters` object, required
        - `collapse` boolean
        - `n` integer, required
      - `strategy` 'BEST_N_PAGES', required
  - `preprocessConfig` object
    - `autoRotate` boolean, required
    - `imageQuality` 'LOW' | 'HIGH', required
    - `maxPages` integer, required
  - `trainingId` string, nullable
  - `width` integer

## Response `200`

200 response

- Model
  - `createdBy` string, nullable, required
  - `createdTime` string, nullable, required
  - `description` string, nullable, required
  - `fieldConfig` object, nullable, required
  - `height` integer, required
  - `metadata` object, nullable, required
  - `modelId` string, required
  - `name` string, nullable, required
  - `numberOfDataBundles` integer, required
  - `numberOfRunningTrainings` integer, required
  - `postprocessConfig` union
    - object
      - `strategy` 'BEST_FIRST', required
    - object
      - `parameters` object, required
        - `collapse` boolean
        - `n` integer, required
      - `strategy` 'BEST_N_PAGES', required
  - `preprocessConfig` object, required
    - `autoRotate` boolean, required
    - `imageQuality` 'LOW' | 'HIGH', required
    - `maxPages` integer, required
  - `status` 'active' | 'inactive', required
  - `trainingId` string, nullable, 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

- **2022-09-29** `424af607ab69` — 2 breaking
  - the response property `fieldConfig` became nullable for the status `200`
  - the response property `metadata` became nullable for the status `200`
- **2022-09-13** `b8d771f64c04` — 6 breaking, 1 warning, 7 info
  - removed the enum value `all` of the request property `fieldConfig/additionalProperties/type`
  - removed the enum value `alphanum` of the request property `fieldConfig/additionalProperties/type`
  - removed the enum value `alphanumext` of the request property `fieldConfig/additionalProperties/type`
  - removed the enum value `letter` of the request property `fieldConfig/additionalProperties/type`
  - …10 more
- **2022-05-27** `4ed1784cbf8b` — 2 info
  - added the new optional request property `postprocessConfig`
  - added the optional property `postprocessConfig` to the response with the `200` status
- **2022-05-19** `3d6e6ac703bb` — 2 breaking, 2 warning, 1 info
  - the `fieldConfig/additionalProperties/enum` request property's minItems was increased to `1`
  - the `fieldConfig/additionalProperties/enum/items/` request property's minLength was increased from `0` to `1`
  - the `fieldConfig/additionalProperties/enum/items/` request property's maxLength was set to `512`
  - changed the pattern of the request property `fieldConfig/additionalProperties/enum/items/` from `[0-9A-Za-z-_]+` to `^[0-9A-Za-zÆØÅæøå!"#$%&()*+,\-./:;<=>?@\[\]\^_`{|}~ ]+$`
  - …1 more
- …earlier changes not shown

[Full 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/424af607ab69/schema)