Back to Home|API Documentation

Fetch Request Status & Results API

Request Path Parameters

ParameterTypeRequiredDescription
request_idStringYesID returned during request creation

Request Status Lifecycle

Main path

REQUESTEDAccepted and queued
IN_PROGRESSActively processing
COMPLETEDResults available
/
FAILEDProcessing error

Review path (when manual review is enabled)

IN_PROGRESSActively processing
REVIEW_PENDINGAwaiting human review
REVIEWEDReview completed
APPROVAL_PENDINGAwaiting approval
APPROVEDApproved and final
/
REJECTEDRejected during review

Sample Response — Status: REQUESTED

json
{
"id": "<REQUEST_ID>",
"pipeline_id": "<PIPELINE_ID>",
"unique_request_id": "<UNIQUE_REQUEST_ID>",
"document_url": ["<DOCUMENT_URL>"],
"status": "REQUESTED",
"request_type": "ASYNC",
"action_type": "EXTRACTION",
"requested_at": "<TIMESTAMP>"
}

Sample Response — Status: IN_PROGRESS

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

Sample Response — Status: COMPLETED

json
{
"id": "<REQUEST_ID>",
"pipeline_id": "<PIPELINE_ID>",
"unique_request_id": "<UNIQUE_REQUEST_ID>",
"status": "COMPLETED",
"request_type": "ASYNC",
"action_type": "DOCUMENT_EXTRACTION",
"result": {
  "extracted_data": { ... },
  "confidence_score": 0.95
}
}

Sample Response — Status: FAILED

json
{
"id": "<REQUEST_ID>",
"pipeline_id": "<PIPELINE_ID>",
"status": "FAILED",
"request_type": "ASYNC",
"action_type": "DOCUMENT_EXTRACTION",
"error": {
  "code": "PROCESSING_ERROR",
  "message": "Failed to extract document content"
}
}