API Reference
Turn a single document to data without a workflow, ad-hoc.
Send an agent to extract data from a document, optionally transforming it to a specific data schema. POST a file called ‘file’. Must be a filetype readable from the dashboard document task (ie pdf or image)
POST
Turn a single document to data without a workflow, ad-hoc.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Additional hints to the AI about what you want to extract
The model to use. Large is slower but may be more accurate. Small is faster but may be less accurate.
Available options:
auto
, large
, small
Attempt to extract extended metadata, like URLs and images
Increasing this will cause the AI to scroll further down the page
Body
A JSON schema to extract against
Example:
{ "schema": { "name": "<the site name>" } }
Response
200 - application/json
An in-progress result, which you can retrieve later with /result/{result_id}
The response is of type object
.
Turn a single document to data without a workflow, ad-hoc.