Classify document by type

Score a document’s similarity to each document type you defined in your Sensible account and to each reference document in the highest-scoring type. To retrieve the scores, poll the download_link in this endpoint’s response until it returns a non-error response. This endpoint is asynchronous. For more information about scores, expand the 200 response in the synchronous classification endpoint.

Use this endpoint:

• In an extraction workflow. For example, determine which documents to extract prior to calling a Sensible extraction endpoint.
• Outside an extraction workflow. For example, to determine where to route each document or to label each document in a system of record.

To post the document bytes, specify the non-encoded document bytes as the entire request body,and specify the Content-Type header, for example,“application/pdf” or “image/jpeg”.

For supported file size and types, see Supported file types.

Authorizations

Authorization · string · header · required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Body

The body is of type file.

Response

200

application/json

Link to download the classification response. Poll the link until it returns a non-error response.

id · string

ID for this classification response.

content_type · string

File format of the document for which you requested classification.

download_link · string<url>

Poll until the download URL returns a non-error response. Links to a JSON download that contains the same response as from the synchronous Classify endpoint request.