---
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
  - `metadata` object
  - `name` string, nullable
  - `postprocessConfig` union
    - object
      - `outputFormat` 'v1' | 'v2'
      - `strategy` 'BEST_FIRST', required
    - object
      - `outputFormat` 'v1' | 'v2'
      - `parameters` object, required
        - `collapse` boolean
        - `n` integer, required
      - `strategy` 'BEST_N_PAGES', required
  - `preprocessConfig` object
    - `autoRotate` boolean
    - `imageQuality` 'LOW' | 'HIGH'
    - `maxPages` integer
    - `pages` integer[]
    - `rotation` 0 | 90 | 180 | 270
    - `startPage` integer
  - `trainingId` string, nullable

## Response `200`

200 response

- Model
  - `createdBy` string, nullable, required
  - `createdTime` string, nullable, required
  - `description` string, nullable, required
  - `fieldConfig` object, nullable, required
  - `metadata` object, nullable, required
  - `modelId` string, required
  - `name` string, nullable, required
  - `numberOfDataBundles` integer, required
  - `numberOfRunningTrainings` integer, required
  - `organizationId` string, required
  - `postprocessConfig` union
    - object
      - `outputFormat` 'v1' | 'v2'
      - `strategy` 'BEST_FIRST', required
    - object
      - `outputFormat` 'v1' | 'v2'
      - `parameters` object, required
        - `collapse` boolean
        - `n` integer, required
      - `strategy` 'BEST_N_PAGES', required
  - `preprocessConfig` object, required
    - `autoRotate` boolean
    - `imageQuality` 'LOW' | 'HIGH'
    - `maxPages` integer
    - `pages` integer[]
    - `rotation` 0 | 90 | 180 | 270
    - `startPage` integer
  - `statistics` object, nullable
  - `status` 'active' | 'inactive', required
  - `trainingId` string, nullable, required
  - `updatedBy` string, nullable, required
  - `updatedTime` string, nullable, required
  - `version` integer

## Other responses

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

## Changes

- **2026-07-13** `d5fe190026be` — 4 breaking, 1 warning, 6 info
  - removed `subschema #1, subschema #2` from the `fieldConfig/patternProperties[^[0-9A-Za-z-_]{1,36}$]/` request property `oneOf` list
  - the `postprocessConfig/oneOf[subschema #2]/parameters/n` response property's max was increased from `3.00` to `100.00` for the response status `200`
  - the `preprocessConfig/maxPages` response property's max was increased from `3.00` to `100.00` for the response status `200`
  - added `subschema #1, subschema #2` to the `fieldConfig/patternProperties[^[0-9A-Za-z-_]{1,36}$]/` response property `oneOf` list for the response status `200`
  - …7 more
- **2024-02-05** `c371d93c085f` — 2 info
  - added the new optional request property `preprocessConfig/startPage`
  - added the optional property `preprocessConfig/startPage` to the response with the `200` status
- **2023-12-07** `4ab3c713635a` — 1 info
  - added the optional property `statistics` to the response with the `200` status
- **2023-12-05** `8290cb385771` — 2 breaking, 2 info
  - removed `subschema #1, subschema #2` from the `postprocessConfig` request property `oneOf` list
  - added `subschema #1, subschema #2` to the `postprocessConfig` response property `oneOf` list for the response status `200`
  - added `subschema #1, subschema #2` to the `postprocessConfig` request property `oneOf` list
  - removed `subschema #1, subschema #2` from the `postprocessConfig` response property `oneOf` list for the response status `200`
- …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/d5fe190026be/schema)