Workflow Endpoints
Get WorkflowRun
API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
Evaluation Set Endpoints
Objects
Webhooks
Workflow Endpoints
Get WorkflowRun
Once a workflow has been run, take the workflowRunId to check the status and output of a specific WorkflowRun.
curl --location --request GET 'https://api-prod.extend.app/v1/workflow_runs/:workflowRunId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"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
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}
Path
The ID of the WorkflowRun that was outputted after a Workflow was run through the API.
Response
A true or false value for whether the request was successful.
An object representing a WorkflowRun. See the WorkflowRun object for the shape of the data.
curl --location --request GET 'https://api-prod.extend.app/v1/workflow_runs/:workflowRunId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"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
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}
curl --location --request GET 'https://api-prod.extend.app/v1/workflow_runs/:workflowRunId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"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
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}