Textin DocFlow API文档
  1. REST API 列表
Textin DocFlow API文档
  • REST API 开发者文档概述
  • DocFlow业务处理流程
  • 接口认证
  • 状态码列表
  • 应用场景
    • 文档解析
    • 文档分类
    • 信息抽取
    • 智能审核
  • REST API 列表
    • 智能审核
      • 审核接口使用教程说明
      • 审核接口字段依赖
      • 文件批次列表
      • 文件任务类别列表
      • 审核规则列表
      • 文件任务列表
      • 模型字段列表
      • 创建审核规则
      • 更新审核规则
      • 删除审核规则
      • 试运行审核规则
      • 提交审核任务
      • 审核规则任务列表
    • 上传文件
      POST
    • 获取文件处理结果列表
      GET
    • 更新文件处理结果
      POST
  1. REST API 列表

上传文件

POST
/api/app-api/sip/platform/v2/file/upload
上传文件
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/file/upload?workspace_id' \
--header 'x-ti-app-id;'
响应示例响应示例
{
    "code": 200,
    "message": "string",
    "result": {
        "batch_number": 202412190001,
        "files": [
            {
                "id": 202412190001,
                "name": "invoice.pdf",
                "format": "pdf"
            }
        ]
    }
}

请求参数

Authorization
在 header 添加参数
x-ti-app-id
示例:
x-ti-app-id: ********************
Query 参数
workspace_id
string 
空间ID
必需
示例值:
1234567890
category
string 
文件类别
可选
示例值:
invoice
batch_number
string 
可选
批次编号。
可以用同一个批次编号上传多次,后续可以用批次编号获取该批次多个文件处理结果。
如果值为空,则系统自动生成最长20位字符串
示例值:
202412190001
auto_verify_vat
boolean 
可选
是否自动进行发票验真
默认值:
false
split_flag
boolean 
是否进行文件拆分
可选
默认值:
false
crop_flag
boolean 
是否进行多图切分
可选
默认值:
false
target_process
enum<string> 
可选
目标处理类型。
可选值:
classify: 分类
extract: 抽取
枚举值:
classifyextract
示例值:
classify
Body 参数multipart/form-data
file
file 
可选

返回响应

🟢200成功
application/json
文件上传成功
Body
code
integer 
状态码
必需
示例值:
200
message
string 
状态描述
必需
result
object 
可选
batch_number
string 
批次编号
必需
示例值:
202412190001
files
array [object {3}] 
必需
上一页
审核规则任务列表
下一页
获取文件处理结果列表
Built with