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": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        },
        "reviewedOutput": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        },
        "output": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        }
      }
    ],
    "workflow": {
      "object": "workflow",
      "id": "workflow_1234",
      "version": "1",
      "name": "test_workflow"
    }
  }
}

Path

workflowRunId
string

The ID of the WorkflowRun that was outputted after a Workflow was run through the API.

Response

success
boolean

A true or false value for whether the request was successful.

workflowRun
WorkflowRun

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": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        },
        "reviewedOutput": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        },
        "output": {
          "is_invoice": {
            "id": "field6",
            "type": "boolean",
            "value": true,
            "confidence": 1,
            "references": []
          },
          "line_items": {
            "id": "field3",
            "type": "array",
            "value": [
              {
                "quantity": 1,
                "unit_price": {
                  "amount": 4.316,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE CHEDDAR SHARP PRIN SYS2822312"
              },
              {
                "quantity": 15,
                "unit_price": {
                  "amount": 17.79,
                  "iso_4217_currency_code": "USD"
                },
                "description": "CHEESE SWISS/AMER 120 SLI 14716"
              }
            ],
            "schema": [
              {
                "id": "subfield1",
                "type": "string",
                "name": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "name": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "name": "quantity",
                "description": "the quantity of the item being sold"
              }
            ],
            "confidence": 0.51,
            "references": [
              {
                "id": "0",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 47,
                    "left": 592,
                    "right": 961,
                    "bottom": 80
                  }
                ]
              },
              {
                "id": "1",
                "page": 1,
                "fieldName": "line_items",
                "boundingBoxes": [
                  {
                    "top": 220,
                    "left": 69,
                    "right": 970,
                    "bottom": 256
                  }
                ]
              }
            ],
          },
          "vendor_name": {
            "id": "field1",
            "type": "string",
            "value": "Sysco",
            "confidence": 0.948,
            "references": [
              {
                "id": "field1",
                "page": 1,
                "fieldName": "vendor_name",
                "boundingBoxes": [
                  {
                    "top": 31,
                    "left": 278,
                    "right": 361,
                    "bottom": 65
                  }
                ]
              }
            ]
          },
          "route_number": {
            "id": "field4",
            "type": "number",
            "value": 2578,
            "confidence": 1,
            "references": [
              {
                "id": "field4",
                "page": 1,
                "fieldName": "route_number",
                "boundingBoxes": [
                  {
                    "top": 85,
                    "left": 608,
                    "right": 636,
                    "bottom": 96
                  }
                ]
              }
            ]
          },
          "delivery_date": {
            "id": "field2",
            "type": "date",
            "value": "2020-07-14",
            "confidence": 0.977,
            "references": []
          },
          "invoice_total": {
            "id": "field5",
            "type": "currency",
            "value": {
              "amount": 324.9,
              "iso_4217_currency_code": "USD"
            },
            "confidence": 0.827,
            "references": [
              {
                "id": "field5",
                "page": 1,
                "fieldName": "invoice_total",
                "boundingBoxes": [
                  {
                    "top": 664,
                    "left": 848,
                    "right": 893,
                    "bottom": 675
                  }
                ]
              }
            ]
          }
        }
      }
    ],
    "workflow": {
      "object": "workflow",
      "id": "workflow_1234",
      "version": "1",
      "name": "test_workflow"
    }
  }
}