> ## 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.

# Get collaboration task

> Retrieve review state, original extraction, review content, and final results.

Use `data.metadata.collaboration_task_id` from the extraction task creation response as `task_id`. See [Human collaboration](/en/api-reference/collaboration) for states and result fields.


## OpenAPI

````yaml en/api-reference/adp-api.yaml GET /open/agentic_doc_processor/{tenant_name}/v1/collaboration/task/{task_id}
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP OpenAPI reference for document extraction, recognition, and
    conversion; extraction application management; webhooks; human
    collaboration; credit usage; workflow discovery, runs, exports, and file
    management.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp-global.laiye.com
    description: ADP global production endpoint
security: []
tags:
  - name: Document extraction
    description: Extract structured fields from uploaded documents.
  - name: Document recognition
    description: Recognize text, layout blocks, and positions from uploaded documents.
  - name: Document conversion
    description: >-
      Convert PDFs, Office documents, OFD files, and images into page images or
      native spreadsheet structures.
  - name: Application management
    description: >-
      Create, update, delete, and query extraction applications and
      configurations.
  - name: Webhook
    description: List system events and manage event callbacks.
  - name: Account
    description: Query credit usage.
  - name: Workflow
    description: >-
      List business workflow templates, run workflow applications, and query run
      results.
  - name: Workflow files
    description: Upload and manage files used by workflow applications.
  - name: Human collaboration
    description: >-
      Configure review triggers, query collaboration tasks, and submit human
      corrections.
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/collaboration/task/{task_id}:
    get:
      tags:
        - Human collaboration
      summary: Get collaboration task
      description: >-
        task_id is the collaboration task primary ID from
        data.metadata.collaboration_task_id in the asynchronous extraction
        creation response. It is not the extraction task_id, display
        task_number, or data ID. Read only the documented business fields and
        avoid logging or forwarding the complete response.


        HTTP 200 does not guarantee business success; check code.


        See [Human collaboration](/en/api-reference/collaboration) for
        integration steps and current limitations.
      operationId: getCollaborationTask
      parameters:
        - $ref: '#/components/parameters/TenantName'
        - name: task_id
          in: path
          required: true
          description: Collaboration task primary ID.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Business response. Check code and read business state back after
            writes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationTaskResponse'
              example:
                code: success
                message: ''
                tips: null
                data:
                  id: collaboration_task_id
                  task_number: COLLAB-001
                  app_id: app_abc123
                  task_state: 2
                  created_at: '2026-10-15T10:00:00Z'
                  updated_at: '2026-10-15T10:00:00Z'
                  extraction_result: []
                  collaboration_result: []
                  output_result: []
        '401':
          description: Missing API key.
        '404':
          description: Invalid API key or inaccessible request.
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 'Tenant name. Default: laiye.'
      schema:
        type: string
        default: laiye
  schemas:
    CollaborationTaskResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Business result code. Success is success; failures may use
            server_error, http_server_error, or other strings. Always check this
            field, including for HTTP 200.
        message:
          type: string
        tips:
          type:
            - string
            - 'null'
        data:
          anyOf:
            - $ref: '#/components/schemas/CollaborationTaskData'
            - type: 'null'
    CollaborationTaskData:
      type: object
      properties:
        id:
          type: string
          description: Collaboration task primary ID, used for queries and file_task_id.
        task_number:
          type: string
          description: Display task number; cannot be used to query or correct a task.
        app_id:
          type: string
        app_name:
          type:
            - string
            - 'null'
        rule_id:
          type:
            - string
            - 'null'
        rule_name:
          type:
            - string
            - 'null'
        rule_logic_operator:
          type:
            - string
            - 'null'
        file_id:
          type:
            - string
            - 'null'
        file_name:
          type:
            - string
            - 'null'
        data_id:
          type:
            - string
            - 'null'
          description: Extraction data ID; distinct from the collaboration task ID.
        data_name:
          type:
            - string
            - 'null'
        message:
          type:
            - string
            - 'null'
        task_state:
          type: integer
          description: >-
            1=waiting, 2=pending human review, 3=passed automatically,
            4=completed by a reviewer, 5=failed, 6=canceled. Submit corrections
            only in state 2.
        task_state_name:
          type:
            - string
            - 'null'
        completed_time:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        thumbnail_file_url:
          type:
            - string
            - 'null'
        converted_file_url_result:
          type:
            - array
            - 'null'
          items:
            type: string
        extraction_result:
          description: Original machine extraction result, retained after human correction.
          type: array
          items:
            $ref: '#/components/schemas/ExtractionField'
        collaboration_result:
          type: array
          items:
            $ref: '#/components/schemas/CollaborationReviewField'
          description: >-
            Collaboration review details, including field review state and
            values. Original machine verification conclusions do not indicate
            whether human review is complete.
        output_result:
          type: array
          items:
            $ref: '#/components/schemas/CollaborationOutputField'
          description: >-
            Merged final result. Confirm task_state=3 or 4 before consuming it;
            read corrected values here after human review.
      required:
        - id
        - task_number
        - app_id
        - task_state
        - created_at
        - updated_at
      description: >-
        Only business fields needed for integration are documented. Responses
        may include unlisted fields; read an allowlist and avoid logging or
        forwarding the entire response.
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic request validation error.
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    ExtractionField:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
        field_name:
          type: string
        field_values:
          type: array
          items:
            type: object
            additionalProperties: true
        references:
          type: array
          items:
            type: object
            additionalProperties: true
        table_values:
          type: array
          items:
            type: array
            items:
              type: object
              additionalProperties: true
    CollaborationReviewField:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
        field_name:
          type: string
        field_values:
          type: array
          items:
            anyOf:
              - type: object
                additionalProperties: true
              - type: array
                items:
                  type: object
                  additionalProperties: true
          description: >-
            Current field values during review; tables may use a two-dimensional
            array.
        references:
          type: array
          items:
            type: object
            additionalProperties: true
        table_values:
          type: array
          items:
            type: array
            items:
              type: object
              additionalProperties: true
        field_verify_values:
          type: array
          items:
            anyOf:
              - type: object
                additionalProperties: true
              - type: array
                items:
                  type: object
                  additionalProperties: true
          description: Confirmed or corrected field values.
        table_verify_values:
          type: array
          items:
            type: array
            items:
              type: object
              additionalProperties: true
          description: Complete confirmed or corrected table.
        field_verify_state:
          type: integer
          description: >-
            Field human confirmation state; 1 indicates confirmed. Use
            task_state to determine task completion.
        field_verify_detail:
          type: object
          additionalProperties: true
          properties:
            verification_passed:
              type: boolean
              description: >-
                May retain the original machine assessment; does not indicate
                whether human review is complete.
            rule_matched:
              type: boolean
            matched_reason:
              type: string
      description: >-
        Field review details. Read extraction_result for the original machine
        extraction.
    CollaborationOutputField:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
        field_name:
          type: string
        field_values:
          type: array
          items:
            anyOf:
              - type: object
                additionalProperties: true
              - type: array
                items:
                  type: object
                  additionalProperties: true
          description: >-
            A table field may also return a two-dimensional cell array here.
            Prefer table_values for table rows and columns.
        references:
          type: array
          items:
            type: object
            additionalProperties: true
        table_values:
          type: array
          items:
            type: array
            items:
              type: object
              additionalProperties: true
      description: >-
        Final output field. Ordinary values are object arrays; read tables from
        the two-dimensional table_values array.
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: Validation error type.
        loc:
          type: array
          description: Location of the invalid field in the request.
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: Human-readable validation error message.
        input:
          description: Input value that failed validation.
        ctx:
          type: object
          additionalProperties: true
          description: Additional context supplied by the validator.
        url:
          type: string
          format: uri
          description: Link to the Pydantic error documentation.
      required:
        - type
        - loc
        - msg
  responses:
    ValidationError:
      description: Validation error.
      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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Production API Key. You can find it under My API in the ADP platform.
        Make sure the API Key is active and belongs to the production
        environment.

````

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