UiPath · Schema

ExtractionRequest

Request payload for extracting data from a previously digitized document

AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

Properties

Name Type Description
documentId string Document ID returned by the digitization endpoint
documentTypeId string Document type identifier to guide extraction
extractorsOptions array Extractors to apply with their configuration options
View JSON Schema on GitHub

JSON Schema

document-understanding-extraction-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-schema/document-understanding-extraction-request-schema.json",
  "title": "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": []
    }
  }
}