Skip to main content
POST
Extract structured data from a document

Authorizations

x-api-key
string
header
required

Your Vern API key. Create one at Settings → API keys.

Body

multipart/form-data
file
file
required

The document to extract. Max 100 MB. Supported: pdf, docx, xlsx, xlsm, xls, xltx, xltm, csv.

templates
string[]

Template slugs to extract against, as returned by GET /templates. Repeat the field or pass one comma-separated value. Omit to use every active template.

Example:
instruction
string

Optional free-text guidance for the extraction, e.g. "only the first schedule".

Response

Accepted. Poll the returned id for the result.

extraction_id
string<uuid>
required
status
enum<string>
required
Available options:
processing
file_name
string
templates
string[]

The template slugs this extraction runs against.

created_at
string<date-time>
expires_at
string<date-time>

After this, the result is deleted and GET returns 410.