API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
Evaluation Set Endpoints
Objects
Webhooks
The WorkflowRun Summary object
{
"id": "workflow_run_1234",
"status": "PROCESSED",
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedByUser": "user@example.com",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"workflowId": "workflow_1234",
"workflowName": "My Workflow",
"workflowVersionId": "workflow_version_1234",
"batchId": "batch_1234",
"rejectionNote": "This workflow run was rejected because it was not valid.",
"createdAt": "2023-01-01T09:41:00.000Z",
"updatedAt": "2023-01-10T05:39:24.500Z"
}
The WorkflowRun Summary object is returned by the List Workflow Runs endpoint.
Full details for a run are available by calling the Get WorkflowRun endpoint.
The workflow run ID.
The batch ID of the WorkflowRun. If that WorkflowRun was created from a batch of files, all runs in that batch will have the same batch ID.
The status of the workflow run.
Possible values include:
PENDING: if the run queued and is waiting to be processedPROCESSING: if the run has started processingNEEDS_REVIEW: if the run needs to be manually reviewed in the UIREJECTED: if the run was manually rejectedPROCESSED: if the run is fully processedFAILED: if the run failed
The time (in UTC) at which the workflow was initially run.
Whether the workflow run has been reviewed.
The email address of the person who reviewed the workflow run.
The time (in UTC) at which the workflow run was reviewed.
The start time (in UTC) of the workflow run.
The end time (in UTC) of the workflow run.
The ID of the workflow that was run.
The name of the workflow that was run.
The ID of the workflow version that was run.
The ID of the batch that the workflow run belongs to.
The note that was added when the workflow run was rejected.
The time (in UTC) at which the workflow run was created.
The time (in UTC) at which the workflow run was last updated.
{
"id": "workflow_run_1234",
"status": "PROCESSED",
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedByUser": "user@example.com",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"workflowId": "workflow_1234",
"workflowName": "My Workflow",
"workflowVersionId": "workflow_version_1234",
"batchId": "batch_1234",
"rejectionNote": "This workflow run was rejected because it was not valid.",
"createdAt": "2023-01-01T09:41:00.000Z",
"updatedAt": "2023-01-10T05:39:24.500Z"
}
{
"id": "workflow_run_1234",
"status": "PROCESSED",
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedByUser": "user@example.com",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"workflowId": "workflow_1234",
"workflowName": "My Workflow",
"workflowVersionId": "workflow_version_1234",
"batchId": "batch_1234",
"rejectionNote": "This workflow run was rejected because it was not valid.",
"createdAt": "2023-01-01T09:41:00.000Z",
"updatedAt": "2023-01-10T05:39:24.500Z"
}