Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
update
Update Single File Category Field
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "field_id": "1234567890",
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "use_prompt": true,
  "alias": [
    "Invoice No.",
    "Bill Number"
  ],
  "identity": "invoice_number",
  "multi_value": true,
  "duplicate_value_distinct": true,
  "transform_settings": {
    "datetime_settings": {
      "format": "yyyy-MM-dd"
    },
    "enumerate_settings": {
      "items": [
        "VAT Special Invoice",
        "VAT General Invoice",
        "Electronic Invoice"
      ]
    },
    "regex_settings": {
      "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "replace": "$1/$2/$3"
    },
    "mismatch_action": {
      "default_value": "N/A"
    }
  },
  "extract_model": "Model 1",
  "table_id": "1234567890",
  "with_detail": true
}
'
{
  "code": 200,
  "msg": "<string>"
}

Authorizations

​
x-ti-app-id
string
header
required
​
x-ti-secret-code
string
header
required

Body

application/json

Field update item (multi_value/duplicate_value_distinct cannot be modified via this endpoint)

​
field_id
string
required

Field ID

Example:

"1234567890"

​
workspace_id
string
required

Workspace ID

Example:

"1234567890"

​
category_id
string
required

File category ID

Example:

"1234567890"

​
name
string

Field name

​
description
string

Field description

​
prompt
string

Semantic extraction prompt

​
use_prompt
boolean

Whether to use semantic prompt

​
alias
string[]

Field aliases. omit=no change, empty array []=clear, non-empty=override

Example:
["Invoice No.", "Bill Number"]
​
identity
string

Export field name. omit=no change, empty string ""=clear, non-empty=override

Example:

"invoice_number"

​
multi_value
boolean

Whether to enable multi-value extraction. Omit=no change

​
duplicate_value_distinct
boolean

Whether to deduplicate values. Only effective when multi_value is true. Omit=no change

​
transform_settings
object

Field output transform configuration. Formats the extraction result before output.

​
extract_model
enum<string>

Field-level extraction model. Only regular fields can be set independently; table fields cannot. Omit to keep existing config.

  • Model 1: Fast speed with stable extraction results
  • Model 2: Suitable for complex document understanding
  • Model 3: VLM, suitable for simple extraction
Available options:
Model 1,
Model 2,
Model 3
Example:

"Model 1"

​
table_id
string

Table ID

  • Not required for regular fields
  • Required for table fields (provide the table ID the field belongs to)
Example:

"1234567890"

​
with_detail
boolean

Whether to return full details. When true, the response returns the updated field's complete info. When not set or false, only code/msg is returned.

Response

200 - application/json

Successfully updated file category field

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description