Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
update
Update File Category
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "name": "Invoice",
  "category_prompt": "VAT invoice, including fields such as invoice code, invoice number, etc.",
  "enabled": 0,
  "extract_model": "Model 1"
}
'
{
  "code": 200,
  "msg": "<string>"
}

Authorizations

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

Body

application/json
​
workspace_id
string
required

Workspace ID

Example:

"1234567890"

​
category_id
string
required

File category ID

Example:

"1234567890"

​
name
string

File category name

Maximum string length: 50
Example:

"Invoice"

​
category_prompt
string

Prompt for classification

Maximum string length: 150
Example:

"VAT invoice, including fields such as invoice code, invoice number, etc."

​
enabled
enum<integer>

Enabled status

  • 0: Disabled
  • 1: Enabled
  • 2: Draft
Available options:
0,
1,
2
​
extract_model
enum<string>

Extraction model

  • 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"

Response

200 - application/json

Successfully updated file category

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description