Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
review
/
runRule
Test Run Review Rule
curl --request POST \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/review/runRule \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '{
  "ruleIdNo": 123,
  "executeTaskIdList": [
    123
  ]
}'
{
  "code": 200,
  "data": {
    "id": 1234,
    "reviewRuleIdNo": 1234,
    "reviewRuleVersion": 1,
    "processStatus": 0,
    "thinkOutput": "Thinking output content",
    "evalOutput": "Evaluation output content",
    "bindingTaskIds": [
      123
    ],
    "resultHighlights": [
      {
        "fileId": 12345,
        "taskId": 1234,
        "text": "Text content",
        "position": [
          1
        ],
        "page": 0,
        "angel": 0,
        "startPos": 0,
        "endPos": 100
      }
    ],
    "evalResult": true,
    "duration": 12345,
    "eval": true,
    "manualAuditStatus": 0,
    "manualAuditMessage": "Annotation content"
  },
  "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

Review API - Single run review rule Request VO

​
ruleIdNo
string
required

Review rule unique ID, same meaning as reviewRuleIdNo

Example:

123

​
executeTaskIdList
string[]
required

Task ID list

Task ID list

Response

200 - */*

OK

​
code
integer

Status code

Example:

200

​
data
object

Review task VO

​
msg
string

Status message

Example:

"Success"

​
traceId
string

Trace ID

Example:

"1234ABCD"

⌘I