Automette docs
API Reference

Classify

POST
/api/v1/documents/classify

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/classify" \  -H "Content-Type: application/json" \  -d '{    "content": "My order arrived broken and I need a replacement today",    "dimensions": [      {        "name": "urgency",        "categories": [          {            "name": "urgent"          },          {            "name": "normal"          }        ]      }    ]  }'
{  "result": {},  "reasons": {},  "credits_used": 0}

Extract data POST

Read a document into fields, with the page each value came from. Leave out `instructions` to get everything the document holds, or describe what to get; give `schema` to fix the field names and types.

Compare POST

Check two to five documents against each other, field by field and line by line, from data already read out of them (for example with Extract data). Returns what matches, what does not, and why.