Retrieve details about a specific classify run, including its status and outputs.
A common use case for this endpoint is to poll for the status and final output of a classify run when using the Create Classify Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
Bearer authentication of the form Bearer <token>, where token is your auth token.
The unique identifier for this classify run.
Example: "cl_Xj8mK2pL9nR4vT7qY5wZ"
The type of object. Will always be "classify_run".
The unique identifier for this classify run.
Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"
The status of a processor run (extract, classify, or split):
"PENDING" - The run has been created and is waiting to be processed"PROCESSING" - The run is in progress"PROCESSED" - The run completed successfully"FAILED" - The run failed"CANCELLED" - The run was cancelledThe final output, either reviewed or initial.
Availability: Present when status is "PROCESSED".
The classifier that was used for this run.
Availability: Present when a classifier reference was provided. Not present when using inline config.
The version of the classifier that was used for this run.
Availability: Present when a classifier reference was provided. Not present when using inline config.
The initial output from the classify run, before any review edits.
Availability: Present when reviewed is true.
The output after human review.
Availability: Present when reviewed is true.
The reason for failure.
Availability: Present when status is "FAILED".
Possible values include:
ABORTED - The run was aborted by the userINTERNAL_ERROR - An unexpected internal error occurredFAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)INVALID_PROCESSOR - The processor configuration is invalidINVALID_CONFIGURATION - The provided configuration is incompatible with the selected modelPARSING_ERROR - Failed to parse the classification outputPRE_PROCESSING_FAILURE - An error occurred during preprocessingPOST_PROCESSING_FAILURE - An error occurred during postprocessingOUT_OF_CREDITS - Insufficient credits to run the classificationNote: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.
A detailed message about the failure.
Availability: Present when status is "FAILED".
Any metadata that was provided when creating the classify run.
Availability: Present when metadata was provided during creation.
The file that was processed. null when the file could not be accessed or processed (for example a run that failed during file ingestion, or a multi-file batch run).
The ID of the parse run that was used for this classify run.
Availability: Present when a parse run was created.
Usage credits consumed by this classify run.
Availability: Present when status is "PROCESSED". Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.
The time (in UTC) at which the object was created. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.
The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.