Skip to main content
PATCH
/
models
/
{modelId}
cURL
curl --request PATCH \
  --url https://api.cradl.ai/{basePath}/models/{modelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "metadata": {},
  "preprocessConfig": {
    "trimMargins": true,
    "useGhostScript": true,
    "startPage": 123,
    "pages": [
      123
    ],
    "usePoppler": true,
    "padToFit": true,
    "useTextDetection": true,
    "maxPages": 50,
    "deskewImage": true,
    "autoRotate": true
  },
  "trainingId": "<string>",
  "postprocessConfig": {
    "strategy": "BEST_FIRST"
  },
  "name": "<string>",
  "description": "<string>",
  "fieldConfig": {}
}
'
{
  "updatedTime": "<string>",
  "metadata": {},
  "updatedBy": "<string>",
  "trainingId": "<string>",
  "modelId": "<string>",
  "description": "<string>",
  "fieldConfig": {},
  "organizationId": "<string>",
  "preprocessConfig": {
    "trimMargins": true,
    "useGhostScript": true,
    "startPage": 123,
    "pages": [
      123
    ],
    "usePoppler": true,
    "padToFit": true,
    "useTextDetection": true,
    "maxPages": 50,
    "deskewImage": true,
    "autoRotate": true
  },
  "createdBy": "<string>",
  "numberOfRunningTrainings": 1,
  "name": "<string>",
  "numberOfDataBundles": 1,
  "createdTime": "<string>",
  "postprocessConfig": {
    "strategy": "BEST_FIRST"
  },
  "version": 1,
  "updatedFieldConfigTime": "<string>",
  "statistics": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Content-Type
string
required

Path Parameters

​
modelId
string
required

Body

application/json
​
metadata
object
​
confidenceVersion
enum<string>
Available options:
v1,
v2
​
llmVersion
enum<string>
Available options:
sonnet-4.0,
sonnet-4.5,
qwen3-vl
​
preprocessConfig
object
​
trainingId
string | null
Pattern: ^las:model-training:[a-z0-9-_]+$
​
postprocessConfig
object
​
name
string | null
Maximum string length: 4096
​
description
string | null
Maximum string length: 4096
​
fieldConfig
object

Response

200 response

​
updatedTime
string | null
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
metadata
object
required
​
updatedBy
string | null
required
Maximum string length: 4096
​
trainingId
string | null
required
Pattern: ^las:model-training:[a-z0-9-_]+$
​
modelId
string
required
Pattern: ^(cradl|las):model:[a-z0-9-_]+$
​
description
string | null
required
Maximum string length: 4096
​
fieldConfig
object
required
​
organizationId
string
required
Pattern: ^(cradl|las):organization:[a-z0-9-_]+$
​
preprocessConfig
object
required
​
createdBy
string
required
Maximum string length: 4096
​
numberOfRunningTrainings
integer
required
Required range: x >= 0
​
name
string | null
required
Maximum string length: 4096
​
numberOfDataBundles
integer
required
Required range: x >= 0
​
createdTime
string
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
status
enum<string>
required
Available options:
active,
inactive
​
llmVersion
enum<string>
Available options:
sonnet-4.0,
sonnet-4.5,
qwen3-vl
​
postprocessConfig
object
​
version
integer
Required range: x >= 0
​
confidenceVersion
enum<string>
Available options:
v1,
v2
​
updatedFieldConfigTime
string | null
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
statistics
object