Classify

Create a Classifier

A Classifier is a reusable, named set of categories. Create once, then run it against many documents with POST /v1/classifiers/{classifier_id}/classify.

post/v1/classifiers

Request

  • Base URL: https://api.documentpro.ai
  • URL: https://api.documentpro.ai/v1/classifiers
  • Auth: API key in header x-api-key

Request body

namestring required

Example request

{
  "name": "Document Type Router",
  "configs": {
    "classes": [
      {
        "label": "invoice",
        "description": "A document requesting payment for goods or services rendered"
      }
    ],
    "page_range": "1-2"
  }
}

Response

Classifier created.

classifier_idstring uuid
namestring
user_idstring uuid
created_atstring date-time
updated_atstring date-time

Example response

{
  "configs": {
    "classes": [
      {
        "label": "invoice",
        "description": "A document requesting payment for goods or services rendered"
      }
    ],
    "page_range": "1-2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.