Automette docs
API Reference

Read a document

POST
/api/v1/documents/read

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/read" \  -H "Content-Type: application/json" \  -d '{    "file": {      "name": "invoice.pdf",      "url": "https://example.com/invoice.pdf"    }  }'
{  "type": "string",  "pageCount": 0,  "pages": [    {}  ],  "sheets": [    {}  ],  "text": "string",  "credits_used": 0}

Send a test event POST

Sends a synthetic `render.completed` payload to the subscription's URL immediately. Useful for verifying signature handling and endpoint connectivity before going live. `status` in the response echoes whatever your endpoint returned: `{ "ok": false, "status": 500 }` means the delivery reached your server but it errored. If your endpoint is unreachable, the response is `502`.

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.