Processor Endpoints
Get ProcessorRun
API Documentation
Workflow Endpoints
Processor Endpoints
Parse 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": {
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"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": {
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"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": {
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"files": [
{
"name": "invoice.pdf"
}
],
"url": "https://platform.extend.app/processor-runs/dpr_1234"
}
}