Create Document Extraction Request API

Request Parameters

Field	Type	Required	Description
unique_request_id	String	No	Client-generated unique identifier for traceability
pipeline_id	String	Yes	Pipeline ID configured for this document type
file	File	Yes	Document file to be processed
bulk_upload	Boolean	No	Whether the request is part of a bulk upload, treating each page as a separate request

Sample Create Request

bash

curl '{BASE_URL}/digiextract/api/v1/requests' \
-H 'Authorization: Basic <base64_encoded_credentials>' \
-H 'Content-Type: multipart/form-data' \
-F 'unique_request_id=<UNIQUE_REQUEST_ID>' \
-F 'pipeline_id=<PIPELINE_ID>' \
-F 'file=@DOCUMENT_FILE_PATH'

Create Request Response

json

{
"id": "<REQUEST_ID>",
"pipeline_id": "<PIPELINE_ID>",
"unique_request_id": "<UNIQUE_REQUEST_ID>",
"status": "REQUESTED",
"request_type": "ASYNC",
"action_type": "EXTRACTION"
}

Response Fields

Field	Type	Required	Description
id	String	No	Unique request identifier (used for polling)
status	String	No	Current processing status
request_type	String	No	Always ASYNC
action_type	String	No	Type of action (EXTRACTION)
pipeline_id	String	No	Pipeline used for extraction
unique_request_id	String	No	Client-provided identifier