The WorkflowRun object is the core object of the WorkflowRun API.
It represents a single run of a workflow and contains all the information about the run, including the output data, the workflow that was run, and the status of the run.
object
string
The type of the object, 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.
name
string
The name of the WorkflowRun. Autogenerated by Extend using fileName if not provided at creation time.
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.)
url
string
Unique URL that can be used to route to the WorkflowRun review experience in Extend.
metadata
any
The metadata that was passed in when running the Workflow.
fileId
string
The ID of the File created as part of this WorkflowRun.
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.
PDFFileMetadata
object
type
string
The type of the file, in this case it will always be “PDF”.
details
object
pageCount
number
The number of pages in the PDF file.
CSVFileMetadata
object
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
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
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
type
string
The type of the file, in this case it will always be “DOCX”.
details
object
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 corresponding to Extraction, Classification, and Instruct QA steps.
This will contain the initial output, reviewed output, and final output of the DocumentProcessorRun.
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.
edits
object
A hash of the edits (original + edited values + operator notes, if any) made to the document processor run. Values conform to the value types of the fields.
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.
object
string
The type of response, in this case it will always be “workflow”.
id
string
The unique identifier of the Workflow.
name
string
The name of the Workflow.
version
string
The version of the Workflow.
stepRuns
WorkflowStepRun[]
An array of WorkflowStepRun objects.
Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run’s output.
Note: This field currently supports External Data Validation and Rule Validation step types.
Document processor run outputs are included in the outputs field.
object
string
The type of response, in this case it will always be “workflow_step_run”.
id
string
The unique identifier of the WorkflowStepRun.
status
enum
The status of the WorkflowStepRun.
One of: PENDING, PROCESSING, PROCESSED, FAILED
output
object
The output of the WorkflowStepRun.
The shape of the output depends on the type of the WorkflowStep in the step field below.
EXTERNAL_DATA_VALIDATION
The output will be the same object that was returned by the external endpoint configured for this step.
RULE_VALIDATION
valid
boolean
Indicates whether the entire validation step passed. This field will only be true if every validation rule passed.
rules
object[]
name
string
The name of the validation rule.
valid
boolean
Indicates whether this validation rule passed or not.
This field will be true only if the formula evaluates to true.
If the rule’s formula is array valued, then this field will only be true if the formula evaluates to true for every item in the array.
validArray
string[]
Only present if the validation rule’s formula is array valued. This field contains the formula’s evaluated result for every item in the array.
failureReason
enum
If the validation rule is not valid, then this describes why the rule failed.
RULE_FAILED: The formula evaluated to false or null.
PARSE_ERROR: The formula could not be parsed.
VALUE_ERROR: An error occurred while evaluating the formula.
error
string
If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error’s details.
step
WorkflowStep
A WorkflowStep object.
object
string
The type of response, in this case it will always be “workflow_step”.
id
string
The unique identifier of the WorkflowStep.
name
string
The name of the WorkflowStep.
type
enum
The name of the WorkflowStep.
One of: EXTERNAL_DATA_VALIDATION, RULE_VALIDATION
