Processor Endpoints
Get ProcessorRun
API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
File Endpoints
Evaluation Set Endpoints
Objects
Webhooks
Processor Endpoints
Get ProcessorRun
Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
curl --location --request GET 'https://api-prod.extend.app/v1/processor_runs/dpr_1234' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"processorRun": {
"object": "document_processor_run",
"id": "dpr_1234",
"processorId": "dp_5678",
"processorVersionId": "dpv_91011",
"processorName": "Invoice Extractor",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"reviewed": true,
"edited": true,
"edits": {
"total_amount": {
"originalValue": "1000.00",
"editedValue": "1100.00",
"fieldType": "currency",
"notes": "Corrected after tax calculation"
}
},
"type": "EXTRACT",
"config": {
"fields": [
{
"id": "total_amount",
"name": "Total Amount",
"type": "currency"
}
]
},
"initialOutput": {
"total_amount": "1000.00"
},
"reviewedOutput": {
"total_amount": "1100.00"
},
"output": {
"total_amount": "1100.00"
},
"files": [
{
"name": "invoice.pdf"
}
],
"url": "https://platform.extend.app/processor-runs/dpr_1234"
}
}
A common use case for this endpoint is to poll for the status and final output of an async processor run when using the Run Processor endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
URL Parameters
The unique identifier of the processor run to retrieve.
Response
A true or false value indicating whether the request was successful.
Details about the requested processor run.
See the ProcessorRun object for more details.
curl --location --request GET 'https://api-prod.extend.app/v1/processor_runs/dpr_1234' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"processorRun": {
"object": "document_processor_run",
"id": "dpr_1234",
"processorId": "dp_5678",
"processorVersionId": "dpv_91011",
"processorName": "Invoice Extractor",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"reviewed": true,
"edited": true,
"edits": {
"total_amount": {
"originalValue": "1000.00",
"editedValue": "1100.00",
"fieldType": "currency",
"notes": "Corrected after tax calculation"
}
},
"type": "EXTRACT",
"config": {
"fields": [
{
"id": "total_amount",
"name": "Total Amount",
"type": "currency"
}
]
},
"initialOutput": {
"total_amount": "1000.00"
},
"reviewedOutput": {
"total_amount": "1100.00"
},
"output": {
"total_amount": "1100.00"
},
"files": [
{
"name": "invoice.pdf"
}
],
"url": "https://platform.extend.app/processor-runs/dpr_1234"
}
}
curl --location --request GET 'https://api-prod.extend.app/v1/processor_runs/dpr_1234' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"processorRun": {
"object": "document_processor_run",
"id": "dpr_1234",
"processorId": "dp_5678",
"processorVersionId": "dpv_91011",
"processorName": "Invoice Extractor",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"reviewed": true,
"edited": true,
"edits": {
"total_amount": {
"originalValue": "1000.00",
"editedValue": "1100.00",
"fieldType": "currency",
"notes": "Corrected after tax calculation"
}
},
"type": "EXTRACT",
"config": {
"fields": [
{
"id": "total_amount",
"name": "Total Amount",
"type": "currency"
}
]
},
"initialOutput": {
"total_amount": "1000.00"
},
"reviewedOutput": {
"total_amount": "1100.00"
},
"output": {
"total_amount": "1100.00"
},
"files": [
{
"name": "invoice.pdf"
}
],
"url": "https://platform.extend.app/processor-runs/dpr_1234"
}
}