Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
file
/
upload
/
sync
Upload File Synchronously
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/file/upload/sync \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --form file='@example-file'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "total": 100,
    "page": 1,
    "page_size": 20,
    "files": [
      {
        "id": 202412190001,
        "name": "invoice.pdf",
        "format": "<string>",
        "recognition_status": 0,
        "verification_status": 0,
        "category": "invoice",
        "task_id": 202412190001,
        "task_detail_url": "<string>",
        "task_type": 1,
        "batch_number": 202412190001,
        "failure_causes": "<string>",
        "pages": [
          {
            "page": 1,
            "angle": 0,
            "width": 1024,
            "height": 1024,
            "dpi": 144
          }
        ],
        "data": {
          "fields": [
            {
              "key": "Invoice Code",
              "identifier": "Invoice Code Identifier",
              "value": "3100231130",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "key": "Invoice Number",
              "value": "28737000",
              "identifier": "Invoice Number Identifier",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "items": [
            [
              {
                "key": "Goods and Services Name",
                "value": "＊Electronic Computer＊Microcomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "Specification Model",
                "value": "DMS-SC68",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ],
            [
              {
                "key": "Goods and Services Name",
                "value": "＊Mechanical Computer＊Supercomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "Specification Model",
                "value": "AN/FSQ-7",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ]
          ],
          "tables": [
            {
              "tableName": "table1",
              "tableType": 0,
              "items": [
                [
                  {
                    "key": "<string>",
                    "identifier": "<string>",
                    "value": "<string>",
                    "textInLines": [
                      {
                        "angle": 0,
                        "pos": [
                          1
                        ],
                        "page": 1,
                        "text": "Text content",
                        "char_pos": [
                          [
                            1
                          ]
                        ]
                      }
                    ],
                    "position": [
                      {
                        "page": 123,
                        "vertices": [
                          123
                        ]
                      }
                    ],
                    "index": 123
                  }
                ]
              ]
            }
          ],
          "stamps": [
            {
              "angel": 0,
              "page": 0,
              "text": "National Unified Invoice Supervision Seal",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "Tax Bureau Seal",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            }
          ],
          "handwritings": [
            {
              "angel": 0,
              "page": 0,
              "text": "March 1st",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "Zhang San",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "invoiceVerifyResult": {
            "invoiceVerifyStatus": 0,
            "invoiceVerifyErrorCode": 0,
            "invoiceVerifyCanRetry": 0,
            "invoiceVerifyFailMsg": "Exceeded daily limit"
          }
        },
        "document": {
          "pages": [
            {
              "angle": 123,
              "width": 123,
              "height": 123,
              "lines": [
                {
                  "text": "<string>",
                  "position": [
                    123
                  ],
                  "charPositions": [
                    [
                      123
                    ]
                  ]
                }
              ]
            }
          ]
        },
        "child_files": [
          {
            "id": 202412190001,
            "task_id": 202412190001,
            "task_detail_url": "<string>",
            "task_type": 1,
            "parent_task_id": 202412190001,
            "batch_number": 202412190001,
            "name": "invoice.pdf",
            "format": "<string>",
            "recognition_status": 0,
            "verification_status": 0,
            "category": "invoice",
            "pages": [
              {
                "page": 1,
                "angle": 0,
                "width": 1024,
                "height": 1024,
                "dpi": 144
              }
            ],
            "data": {
              "fields": [
                {
                  "key": "Invoice Code",
                  "identifier": "Invoice Code Identifier",
                  "value": "3100231130",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "key": "Invoice Number",
                  "value": "28737000",
                  "identifier": "Invoice Number Identifier",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "items": [
                [
                  {
                    "key": "Goods and Services Name",
                    "value": "＊Electronic Computer＊Microcomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "Specification Model",
                    "value": "DMS-SC68",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ],
                [
                  {
                    "key": "Goods and Services Name",
                    "value": "＊Mechanical Computer＊Supercomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "Specification Model",
                    "value": "AN/FSQ-7",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ]
              ],
              "tables": [
                {
                  "tableName": "table1",
                  "tableType": 0,
                  "items": [
                    [
                      {
                        "key": "<string>",
                        "identifier": "<string>",
                        "value": "<string>",
                        "textInLines": [
                          {
                            "angle": 0,
                            "pos": [
                              1
                            ],
                            "page": 1,
                            "text": "Text content",
                            "char_pos": [
                              [
                                1
                              ]
                            ]
                          }
                        ],
                        "position": [
                          {
                            "page": 123,
                            "vertices": [
                              123
                            ]
                          }
                        ],
                        "index": 123
                      }
                    ]
                  ]
                }
              ],
              "stamps": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "National Unified Invoice Supervision Seal",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "Tax Bureau Seal",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ],
              "handwritings": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "March 1st",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "Zhang San",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "invoiceVerifyResult": {
                "invoiceVerifyStatus": 0,
                "invoiceVerifyErrorCode": 0,
                "invoiceVerifyCanRetry": 0,
                "invoiceVerifyFailMsg": "Exceeded daily limit"
              }
            },
            "document": {
              "pages": [
                {
                  "angle": 123,
                  "width": 123,
                  "height": 123,
                  "lines": [
                    {
                      "text": "<string>",
                      "position": [
                        123
                      ],
                      "charPositions": [
                        [
                          123
                        ]
                      ]
                    }
                  ]
                }
              ]
            },
            "from_parent_position_list": [
              1
            ],
            "crop_info": {
              "page": 123,
              "imageAngle": "<string>"
            }
          }
        ],
        "duration_ms": 10000,
        "total_page_num": 10
      }
    ]
  }
}

Authorizations

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

Query Parameters

​
workspace_id
string
required

Workspace ID

Example:

1234567890

​
category
string

File Category

Example:

"invoice"

​
batch_number
string

Batch Number. You can upload multiple times with the same batch number, and later retrieve processing results for multiple files in that batch using the batch number. If the value is empty, the system automatically generates a string up to 20 characters long.

Example:

202412190001

​
auto_verify_vat
boolean
default:false

Whether to automatically verify VAT invoice

​
split_flag
boolean
default:false

Whether to perform file splitting

​
crop_flag
boolean
default:false

Whether to perform multi-image cropping

​
target_process
enum<string>

Target processing type. Optional values: - classify: Classification - extract: Extraction

Available options:
classify,
extract
Example:

"classify"

​
parser_remove_watermark
integer
default:0

Remove watermark (0 no, 1 yes)

​
parser_crop_dewarp
integer
default:0

Crop and dewarp (0 no, 1 yes)

​
parser_apply_merge
integer
default:1

Merge cross-page paragraphs and tables (0 no, 1 yes)

​
parser_formula_level
integer
default:0

Formula recognition level (0 recognizes both display and inline formulas, 1 recognizes display formulas only, 2 recognizes no formulas)

​
parser_table_text_split_mode
integer
default:0

Split text blocks crossed by table lines (0 no, 1 yes)

​
with_task_detail_url
boolean
default:false

Whether to return the task details page URL

Body

File upload request body

​
file
file

Response

200 - application/json

File uploaded and processed successfully

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description

​
result
object