Bulk document extraction (Async)

post

Authorizations

X-Api-KeystringRequired

Body

Responses

200

OK

application/json

failedintegerRequired

Number of failed files

messagestring · nullableOptional

Status message

Default: null

statusstringOptional

Status of the bulk extraction request

Default: success

successfulintegerRequired

Number of successfully queued files

totalintegerRequired

Total number of files submitted

400

Bad Request

application/json

401

Authentication required — the X-Api-Key header is missing or invalid.

post/extract/bulk

POST /extract/bulk HTTP/1.1
Host: api-docai-uat.uptiq.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1027

{
  "files": [
    {
      "additionalParams": {
        "extractImages": false,
        "imageInstructions": "text",
        "returnFieldConfidences": false
      },
      "agentInstructions": "text",
      "analysisDepth": "standard",
      "chartOfAccounts": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "chartOfAccountsUrl": "text",
      "content": "text",
      "custom_document_types": [
        "text"
      ],
      "documentType": "text",
      "documentTypes": [
        {
          "documentType": "text",
          "entity": "text",
          "entityId": "text",
          "pageNumbers": [
            1
          ],
          "sheetNames": [
            "text"
          ]
        }
      ],
      "enableCaching": false,
      "enableDocumentAnalysis": true,
      "enableJudge": false,
      "enablePageContent": false,
      "enablePageSummaries": false,
      "enableRawSections": false,
      "extractionFormat": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "extractionPrompt": "text",
      "file_url": "text",
      "form8825Address": "text",
      "form8825Addresses": [
        "text"
      ],
      "formTypes": [
        "text"
      ],
      "galleryIds": [
        "text"
      ],
      "includeLayout": false,
      "industry": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "model": "gemini-3",
      "overrideCache": false,
      "query": "text",
      "quickExtract": false,
      "rawExtractionOnly": false,
      "subtype": "text",
      "tagInstructions": "text"
    }
  ]
}

{
  "failed": 1,
  "message": "text",
  "results": [
    {
      "_id": "text",
      "document_type": "text",
      "error": "text",
      "index": 1,
      "requestId": "text",
      "status": "text",
      "subtype": "text"
    }
  ],
  "status": "success",
  "successful": 1,
  "total": 1
}