Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
file
/
upload
cURL
curl -X POST \
-H 'x-ti-app-id: 1234567890' \
-H 'x-ti-secret-code: 1234567890' \
-F 'file=@invoice.pdf'
-F 'file=@another.pdf'
'https://docflow.textin.ai/api/app-api/sip/platform/v2/file/upload?workspace_id=1234567890&category=invoice&batch_number=202412190001'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "batch_number": 202412190001,
    "files": [
      {
        "id": 202412190001,
        "name": "invoice.pdf",
        "format": "pdf"
      }
    ]
  }
}

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 required: false

Available options:
classify,
extract
Example:

"classify"

Body

multipart/form-data
​
file
file

Response

200 - application/json

File upload successful

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description

​
result
object
⌘I