Sign in
Classifier
Beta
Classifier

Create Classify Job

Create a classify job. Experimental: not production-ready and subject to change.

post/api/v1/classifier/jobs

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

mode'FAST' | 'MULTIMODAL'

Supported classification execution modes.

file_idsstring[] required

The IDs of the files to classify

Example request

{
  "rules": [
    {
      "type": "invoice",
      "description": "contains invoice number, line items, and total amount"
    }
  ],
  "webhook_configurations": [
    {
      "webhook_events": [
        "parse.success",
        "parse.error"
      ],
      "webhook_output_format": "json"
    }
  ]
}

Response

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

mode'FAST' | 'MULTIMODAL'

Supported classification execution modes.

Example response

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

Changes

Changed in 2 of the 33 revisions of this API.3

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8a46948077ea1See the full diff
    • ○

      added the new optional request property webhook_configurations/items/webhook_output_format

      new-optional-request-property