> ## Documentation Index
> Fetch the complete documentation index at: https://docs-docflow.textin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 上传文件



## OpenAPI

````yaml /docflow/cn/rest-api/openapi.bundle.yaml post /api/app-api/sip/platform/v2/file/upload
openapi: 3.0.0
info:
  title: DocFlow API
  description: DocFlow REST API，提供文件上传和获取文件处理结果能力
  version: 2.8.4
servers:
  - url: https://docflow.textin.com
security:
  - ApiId: []
    SecretCode: []
paths:
  /api/app-api/sip/platform/v2/file/upload:
    post:
      summary: 上传文件
      operationId: uploadFile
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
        - $ref: '#/components/parameters/Category'
        - $ref: '#/components/parameters/BatchNumber'
        - $ref: '#/components/parameters/AutoVerifyVat'
        - $ref: '#/components/parameters/SplitFlag'
        - $ref: '#/components/parameters/CropFlag'
        - $ref: '#/components/parameters/TargetProcess'
        - $ref: '#/components/parameters/ParserRemoveWatermark'
        - $ref: '#/components/parameters/ParserCropDewarp'
        - $ref: '#/components/parameters/ParserApplyMerge'
        - $ref: '#/components/parameters/ParserFormulaLevel'
        - $ref: '#/components/parameters/ParserTableTextSplitMode'
        - $ref: '#/components/parameters/ParserDpi'
        - $ref: '#/components/parameters/ParserParseMode'
        - $ref: '#/components/parameters/ParserPdfPwd'
      requestBody:
        $ref: '#/components/requestBodies/FileUploadRequestBody'
      responses:
        '200':
          description: 文件上传成功
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CodeMessage'
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          batch_number:
                            type: string
                            description: 批次编号
                            example: 202412190001
                          files:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  description: 文件ID
                                  example: 202412190001
                                task_id:
                                  type: string
                                  description: 任务ID
                                  example: 1981692246135111700
                                name:
                                  type: string
                                  description: 文件名
                                  example: invoice.pdf
                                format:
                                  type: string
                                  description: 文件格式
                                  example: pdf
                              required:
                                - id
                                - name
                                - format
                        required:
                          - batch_number
                          - files
components:
  parameters:
    WorkspaceId:
      name: workspace_id
      in: query
      description: 空间ID
      required: true
      schema:
        type: string
        example: 1234567890
    Category:
      name: category
      in: query
      description: 文件类别
      required: false
      schema:
        type: string
        example: invoice
    BatchNumber:
      name: batch_number
      in: query
      description: |
        批次编号。  
        可以用同一个批次编号上传多次，后续可以用批次编号获取该批次多个文件处理结果。  
        如果值为空，则系统自动生成最长20位字符串
      required: false
      schema:
        type: string
        example: 202412190001
    AutoVerifyVat:
      name: auto_verify_vat
      in: query
      description: 是否自动进行发票验真
      required: false
      schema:
        type: boolean
        default: false
    SplitFlag:
      name: split_flag
      in: query
      description: 是否进行文件拆分
      required: false
      schema:
        type: boolean
        default: false
    CropFlag:
      name: crop_flag
      in: query
      description: 是否进行多图切分
      required: false
      schema:
        type: boolean
        default: false
    TargetProcess:
      name: target_process
      in: query
      description: |
        目标处理类型。  
        可选值：  
        - `classify`: 分类  
        - `extract`: 抽取  
      required: false
      schema:
        type: string
        enum:
          - classify
          - extract
        example: classify
    ParserRemoveWatermark:
      name: parser_remove_watermark
      in: query
      description: 是否去水印（0:不去水印、1:去水印）
      required: false
      schema:
        type: integer
        default: 0
    ParserCropDewarp:
      name: parser_crop_dewarp
      in: query
      description: 是否进行切边矫正（0:不进行切边矫正、1:进行切边矫正）
      required: false
      schema:
        type: integer
        default: 0
    ParserApplyMerge:
      name: parser_apply_merge
      in: query
      description: 是否进行跨页段落表格合并（0:不合并、1:合并）
      required: false
      schema:
        type: integer
        default: 1
    ParserFormulaLevel:
      name: parser_formula_level
      in: query
      description: 公式识别等级(0 行间公式和行内公式都识别、1 仅识别行间公式，行内公式不识别、2 不识别公式)
      required: false
      schema:
        type: integer
        default: 0
    ParserTableTextSplitMode:
      name: parser_table_text_split_mode
      in: query
      description: 表格线是否分割ocr文本（0:不切割、1:切割）
      required: false
      schema:
        type: integer
        default: 0
    ParserDpi:
      name: parser_dpi
      in: query
      description: 文件分辨率（144:默认、216:高精度）
      required: false
      schema:
        type: integer
        default: 144
        enum:
          - 144
          - 216
    ParserParseMode:
      name: parser_parse_mode
      in: query
      description: |
        解析模式
        - `auto`: 自动（默认）
        - `scan`: 扫描件模式
        - `vlm`: VLM模式
      required: false
      schema:
        type: string
        enum:
          - auto
          - scan
          - vlm
    ParserPdfPwd:
      name: parser_pdf_pwd
      in: query
      description: PDF文件密码，用于解密加密的PDF文件
      required: false
      schema:
        type: string
  requestBodies:
    FileUploadRequestBody:
      description: 文件上传请求体
      required: true
      content:
        multipart/form-data:
          schema:
            type: object
            properties:
              file:
                type: string
                format: binary
        application/json:
          schema:
            type: object
            properties:
              urls:
                description: |
                  文件URL列表
                  一次最多支持上传10个文件URL，每个文件最大不超过100MB
                type: array
                items:
                  type: string
                  description: 文件URL
                  example: https://example.com/file.pdf
                  pattern: ^https?://.*$
                maxItems: 10
            required:
              - urls
  schemas:
    CodeMessage:
      type: object
      properties:
        code:
          type: integer
          description: 状态码
          example: 200
        msg:
          type: string
          description: 状态描述
      required:
        - code
        - msg
  securitySchemes:
    ApiId:
      type: apiKey
      in: header
      name: x-ti-app-id
    SecretCode:
      type: apiKey
      in: header
      name: x-ti-secret-code

````