Create Classify Job

Create a classify job. Experimental: This endpoint is not yet ready for production use and is subject to change at any time.

post/api/v1/classifier/jobs

Request

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

file_idsstring[] required

The IDs of the files to classify

{
  "rules": [
    {
      "type": "invoice",
      "description": "contains invoice number, line items, and total amount"
    }
  ]
}

Successful Response

status'PENDING' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED' required

Enum for representing the status of a job

effective_atstring date-time

job_record_idstring nullable

The job record ID associated with this status, if any.

error_messagestring nullable

Error message for the latest job attempt, if any.

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

user_idstring required

The ID of the user

project_idstring uuid required

The ID of the project

{
  "rules": [
    {
      "type": "invoice",
      "description": "contains invoice number, line items, and total amount"
    }
  ]
}