The ProcessorRun object

The ProcessorRun object is the core object of processor runs, and is returned by the Run Processor endpoint as well as the Get Processor Run endpoint. These objects also represent a single output of a workflow run, which would typically have a list of multiple processor runs for chained processors.

The object represents a single run of a processor and contains all the information about the run, including the output data, the processor that was run, and the status of the run.

object

string

The type of response, will always be “document_processor_run”.

string

The unique identifier for this processor run.

output

object

The final output, either reviewed or initial.

Conforms to the shape of output types and depends on the processor type and configuration shape.

processorId

string

The ID of the processor used for this run.

processorVersionId

string

The ID of the specific processor version used.

processorName

string

The name of the processor.

status

string

The current status of the processor run (e.g., “PROCESSING”, “PROCESSED”, “FAILED”).

failureReason

string

If the run failed, indicates the reason for failure.

failureMessage

string

If the run failed, provides a detailed message about the failure.

metadata

object

Any metadata that was provided when creating the processor run.

reviewed

boolean

Indicates whether the run has been reviewed.

edited

boolean

Indicates whether the run results have been edited.

edits

object

Contains any edits made to the processor output.

type

string

The type of processor (e.g., “EXTRACT”, “CLASSIFY”).

config

object

The configuration used for this processor run.

initialOutput

object

The initial output from the processor.

reviewedOutput

object

The output after review, if any.

files

array

Details of the processed files.

If this was a file generated from a splitter processor, this will be the sub file.

See the File object for more details.

url

string

URL to view the processor run.

API Documentation

Workflow Endpoints

Processor Endpoints

File Endpoints

Evaluation Set Endpoints

Objects

Guides

Webhooks

The ProcessorRun object