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

# 创建文档转换异步任务

> 创建文档转换任务并立即返回 task_id。当前队列消息保留约 1 小时，单任务消费超时约 180 秒，结果文件通常约 1 小时有效；这些时长尚未作为稳定 SLA。

创建失败仍可能表现为 HTTP 200、code=success、data=null，必须确认 data.task_id 非空。请使用查询接口轮询结果，并采用退避策略。




## OpenAPI

````yaml api-reference/adp-api.yaml POST /open/agentic_doc_processor/{tenant_name}/v1/doc/convert/create/task
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP 官方 OpenAPI
    接口规范，覆盖文档抽取、解析与转换，抽取应用管理、Webhook、人机协同、积分查询，以及工作流发现、运行、导出和文件管理。
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp.laiye.com
    description: ADP 生产环境
security: []
tags:
  - name: 文档抽取
    description: 从上传的文档中抽取结构化字段。
  - name: 文档解析
    description: 识别上传文档中的文字、版面块和位置信息。
  - name: 文档转换
    description: 将 PDF、Office、OFD 和图片转换为页面图片或电子表格结构。
  - name: 应用管理
    description: 创建、修改、删除和查询抽取应用及配置。
  - name: Webhook
    description: 查询事件目录并管理事件回调。
  - name: 账户
    description: 查询账户积分和使用情况。
  - name: 工作流
    description: 查询业务工作流模板、运行工作流应用并查询执行结果。
  - name: 工作流文件
    description: 上传和管理工作流应用使用的文件。
  - name: 人机协同
    description: 配置审核触发规则，查询协同任务并提交人工修正。
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/doc/convert/create/task:
    post:
      tags:
        - 文档转换
      summary: 创建文档转换异步任务
      description: >
        创建文档转换任务并立即返回 task_id。当前队列消息保留约 1 小时，单任务消费超时约 180 秒，结果文件通常约 1
        小时有效；这些时长尚未作为稳定 SLA。


        创建失败仍可能表现为 HTTP 200、code=success、data=null，必须确认 data.task_id
        非空。请使用查询接口轮询结果，并采用退避策略。
      operationId: createDocumentConvertTask
      parameters:
        - $ref: '#/components/parameters/TenantName'
      requestBody:
        $ref: '#/components/requestBodies/DocumentConvertAsyncRequest'
      responses:
        '200':
          $ref: '#/components/responses/DocumentConvertTaskResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 租户名称，默认 laiye。
      schema:
        type: string
        default: laiye
  requestBodies:
    DocumentConvertAsyncRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DocumentConvertAsyncRequest'
          example:
            file_url: https://example.com/long-document.pdf
            first_convert_page: 1
            last_convert_page: 20
  responses:
    DocumentConvertTaskResponse:
      description: 文档转换异步任务创建结果。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DocumentConvertTaskResponse'
          examples:
            created:
              value:
                code: success
                message: ''
                tips: null
                data:
                  task_id: task_abc123
            failedButWrappedAsSuccess:
              summary: 当前失败分支可能出现的响应
              value:
                code: success
                message: ''
                tips: null
                data: null
    ValidationError:
      description: 参数校验错误。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
          example:
            detail:
              - type: greater_than
                loc:
                  - query
                  - limit
                msg: Input should be greater than 0
                input: 0
                ctx:
                  gt: 0
  schemas:
    DocumentConvertAsyncRequest:
      type: object
      additionalProperties: false
      oneOf:
        - title: 使用文件 URL
          required:
            - file_url
        - title: 使用 Base64 文件
          required:
            - file_base64
      properties:
        file_url:
          type: string
          format: uri
          maxLength: 2048
          description: 待转换文件的公网 HTTPS URL。
        file_base64:
          type: string
          format: byte
          description: 待转换文件的 Base64 内容。解码后最大 50 MiB。
        scale:
          type: number
          exclusiveMinimum: 0
          default: 1
        first_convert_page:
          type: integer
          minimum: 1
        last_convert_page:
          type: integer
          minimum: 1
      description: 异步转换当前固定以 URL 返回页面结果，后端会忽略 result_mode，因此公共合同不暴露该字段。
    DocumentConvertTaskResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              oneOf:
                - type: object
                  properties:
                    task_id:
                      type: string
                  required:
                    - task_id
                - type: 'null'
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic 请求参数校验错误。
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: 业务码。成功通常为 success 或 200。
        message:
          type: string
          description: 返回信息。
        tips:
          type:
            - string
            - 'null'
          description: 详细信息，默认为空。
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: 校验错误类型。
        loc:
          type: array
          description: 错误字段在请求中的位置。
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: 可读的错误说明。
        input:
          description: 导致校验失败的输入值。
        ctx:
          type: object
          additionalProperties: true
          description: 校验器提供的补充上下文。
        url:
          type: string
          format: uri
          description: Pydantic 错误说明链接。
      required:
        - type
        - loc
        - msg
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 生产环境 API Key，可在 ADP 平台的「我的 API」中查看。请确保 API Key 有效且属于生产环境。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.