Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
review
/
create
Create Review Rule
curl --request POST \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/review/create \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '{
  "ruleName": "Review rule 123",
  "rulePrompt": "Review rule prompt content",
  "classificationIdNoList": [
    123
  ],
  "fileBatchNo": "abcd",
  "workspaceIdNo": 123,
  "fields": [
    {
      "classificationIdNo": 1234,
      "classificationName": "ID Card",
      "basicFields": [
        {
          "fieldId": 1234,
          "fieldName": "Card Number"
        }
      ],
      "tableFields": [
        {
          "tableId": -1,
          "tableName": "Table1",
          "fields": [
            {
              "fieldId": 1234,
              "fieldName": "Card Number"
            }
          ]
        }
      ]
    }
  ]
}'
{
  "code": 200,
  "data": {
    "ruleIdNo": 1234
  },
  "msg": "Success",
  "traceId": "1234abcd"
}

Authorizations

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

Headers

​
x-ti-app-id
string
required

x-ti-app-id

Example:

"1234abcd"

​
x-ti-secret-code
string
required

x-ti-secret-code

Example:

"1234abcd"

Body

application/json

Create rule ReqVO

​
ruleName
string
required

Review rule name

Maximum length: 255
Example:

"Review rule 123"

​
rulePrompt
string
required

Review rule prompt

Maximum length: 1000
Example:

"Review rule prompt content"

​
classificationIdNoList
string[]
required

Classification ID list

Required array length: 1 - 2147483647 elements

Classification ID

​
fileBatchNo
string
required

File batch number

Example:

"abcd"

​
workspaceIdNo
string
required

Workspace ID

Example:

123

​
fields
object[]

Associated field information

Response

200 - */*

OK

​
code
integer

Status code

Example:

200

​
data
object

Create rule response result VO

​
msg
string

Status message

Example:

"Success"

​
traceId
string

Trace ID

Example:

"1234abcd"

⌘I