UiPath · JSON Structure

Document Understanding Extraction Request Structure

Request payload for extracting data from a previously digitized document

Type: object Properties: 3 Required: 2
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

ExtractionRequest is a JSON Structure definition published by UiPath, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

documentId documentTypeId extractorsOptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/document-understanding-extraction-request-structure.json",
  "name": "ExtractionRequest",
  "description": "Request payload for extracting data from a previously digitized document",
  "type": "object",
  "required": [
    "documentId",
    "extractorsOptions"
  ],
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Document ID returned by the digitization endpoint",
      "example": "abc123"
    },
    "documentTypeId": {
      "type": "string",
      "description": "Document type identifier to guide extraction",
      "example": "abc123"
    },
    "extractorsOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExtractorOption"
      },
      "description": "Extractors to apply with their configuration options",
      "example": []
    }
  }
}