Classify File (Async)
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
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.
Request
Reference to an existing classifier. One of classifier or config must be provided.
Inline classify configuration. One of classifier or config must be provided.
Response
The type of object. Will always be "classify_run".
The unique identifier for this classify run.
Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"
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 final output, either reviewed or initial.
Availability: Present when status is "PROCESSED".
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.
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 ID of the parse run that was used for this classify run.
Availability: Present when a parse run was created.
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"

