Automette docs
API Reference

Compare

POST
/api/v1/documents/compare

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from API Keys in the dashboard menu.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/documents/compare" \  -H "Content-Type: application/json" \  -d '{    "sides": [      {        "name": "Invoice",        "data": {          "total": 1250        }      },      {        "name": "PO",        "data": {          "total": 1200        }      }    ]  }'
{  "status": "string",  "fields": [    {}  ],  "lines": [    {}  ],  "summary": "string",  "credits_used": 0}

Classify POST

Sort a document, or text or data you send, into your categories, with a reason for each. Several questions can be answered at once, one per item in `dimensions`.

Split a PDF POST

Split one PDF into separate documents: by page ranges, by a number pattern that starts each one (an invoice number), or by a description of where each document starts. Each part comes back as a file with a download link.