Get WorkflowRun

Once a workflow has been run, take the workflowRunId to check the status and output of a specific WorkflowRun.

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.

Hide properties

object · string

The type of response, in this case it will always be “workflow_run”.

id · string

An ID corresponding to a specific File x Workflow combination representing the specific WorkflowRun for a File.

status · string

The status of a WorkflowRun. The options are “PENDING” (if the WorkflowRun is still running), “FAILED” (if the WorkflowRun failed), “NEEDS_REVIEW” (if the WorkflowRun needs to be reviewed manually in the UI), “REVIEWED” (if the WorkflowRun has been manually reviewed and corrected), “PROCESSED” (if the WorkflowRun is fully processed.)

metadata · any

The metadata that was passed in when running the Workflow.

fileName · string

The name of the File associated with this WorkflowRun.

fileUrl · string

A URL internal to Extend for the file. This URL is not public and will not be accessible without the proper authentication.

fileMetadata · oneOf

Metadata about the file. This is an optional field which will only be present once the file has finished processing. The shape of the object depends on the type of file that was processed.

Show types

PDFFileMetadata · object

Show properties

type · string

The type of the file, in this case it will always be “PDF”.

details · object

Show properties

pageCount · number

The number of pages in the PDF file.

CSVFileMetadata · object

Show properties

type · string

The type of the file, in this case it will always be “CSV”.

details · object

An empty object, this may have more details in the future.

IMGFileMetadata · object

Show properties

type · string

The type of the file, in this case it will always be “IMG”.

details · object

An empty object, this may have more details in the future.

TXTFileMetadata · object

Show properties

type · string

The type of the file, in this case it will always be “TXT”.

details · object

An empty object, this may have more details in the future.

DOCXFileMetadata · object

Show properties

type · string

The type of the file, in this case it will always be “DOCX”.

details · object

Show properties

pageCount · number

The number of pages in the DOCX file.

initialRunAt · string

The time (in UTC) at which the workflow was initially run.

failureMessage · string

An optional field that will only be present if applicable. This will be the error message if the WorkflowRun failed.

reviewedBy · string

An optional field that will only be present if applicable. This will be the user ID of the person who reviewed the WorkflowRun.

reviewedAt · string

An optional field that will only be present if applicable. The time (in UTC) at which the WorkflowRun review step was completed.

startTime · string

The start time (in UTC) of the WorkflowRun.

endTime · string

An optional field that will only be present if applicable. The end time (in UTC) of the WorkflowRun.

outputs · DocumentProcessorRun[]

An array of DocumentProcessorRun objects. This will contain the initial output, reviewed output, and final output of the WorkflowRun.

DocumentProcessorRun · DocumentProcessorRun

An object representing a DocumentProcessorRun.

Hide properties

object · string

Type of the object, always ‘document_processor_run’.

id · string

The unique identifier for the document processor run.

edited · boolean

Whether the document processor run has been edited.

type · string

The type of the document processor run. Either EXTRACT, CLASSIFY, or INSTRUCT_QA.

config · object

The config of the document processor run. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

initialOutput · object

The initial raw output from the document processor. This is always set. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

reviewedOutput · object

An optional field that shows the output after review, if applicable. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

output · object

The final output, either reviewed or initial. You can rely on this to be always set as the final ouput (initial or post review when reviewed). The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

workflow · Workflow

The details about the Workflow that was used in this WorkflowRun.

Show properties

object · string

The type of response, in this case it will always be “workflow”.

id · string

The Workflow ID that can be fetched from the Extend Platform.

name · string

The name of the Workflow.

version · string

The version of the Workflow.

Workflow · object

Show properties

id · string

The Workflow ID that can be fetched from the Extend Platform.

name · string

The name of the Workflow.

version · string

The version of the Workflow.

Example Request

curl --location --request GET 'https://api-prod.extend.app/v1/workflow_runs/:workflowRunId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>'

Example Response

{
  "success": true,
  "workflowRun": {
    "object": "workflow_run",
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "metadata": {
      "internal_id": "id_1234"
    },
    "fileName": "example_file_name.pdf",
    "fileUrl": "https://extend-files.s3.us-east-2.amazonaws.com/example+file+name.pdf",
    "fileMetadata": {
      "type": "PDF",
      "details": {
        "pageCount": 3
      }
    },
    "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",
        "config": {
          "fieldsToExtract": [
            {
              "id": "field6",
              "type": "boolean",
              "fieldName": "is_invoice",
              "description": "Is this an invoice?"
            },
            {
              "id": "field1",
              "type": "string",
              "fieldName": "vendor_name",
              "description": "the name of the vendor"
            },
            {
              "id": "field2",
              "type": "date",
              "fieldName": "delivery_date",
              "description": "the delivery date"
            },
            {
              "id": "field4",
              "type": "number",
              "fieldName": "route_number",
              "description": "the route number"
            },
            {
              "id": "field5",
              "type": "currency",
              "fieldName": "invoice_total",
              "description": "the invoice total"
            },
            {
              "id": "field3",
              "type": "any[]",
              "schema": [
                {
                  "id": "subfield1",
                  "type": "string",
                  "fieldName": "description",
                  "description": "the description of the item being sold"
                },
                {
                  "id": "subfield2",
                  "type": "currency",
                  "fieldName": "unit_price",
                  "description": "the unit price of the item being sold"
                },
                {
                  "id": "subfield3",
                  "type": "number",
                  "fieldName": "quantity",
                  "description": "the quantity of the item being sold"
                }
              ],
              "fieldName": "line_items",
              "description": "the list of items being sold"
            }
          ]
        },
        "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",
                "fieldName": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "fieldName": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "fieldName": "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
									}
								]
							}
						],
            "arrayJSONSchema": "{\"description\": \"string\", \"unit_price\": {\"amount\":\"number\",\"iso_4217_currency_code\":\"string\"}, \"quantity\": \"number\"}"
          },
          "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",
                "fieldName": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "fieldName": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "fieldName": "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
									}
								]
							}
						],
            "arrayJSONSchema": "{\"description\": \"string\", \"unit_price\": {\"amount\":\"number\",\"iso_4217_currency_code\":\"string\"}, \"quantity\": \"number\"}"
          },
          "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",
                "fieldName": "description",
                "description": "the description of the item being sold"
              },
              {
                "id": "subfield2",
                "type": "currency",
                "fieldName": "unit_price",
                "description": "the unit price of the item being sold"
              },
              {
                "id": "subfield3",
                "type": "number",
                "fieldName": "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
									}
								]
							}
						],
            "arrayJSONSchema": "{\"description\": \"string\", \"unit_price\": {\"amount\":\"number\",\"iso_4217_currency_code\":\"string\"}, \"quantity\": \"number\"}"
          },
          "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"
    }
  }
}