Skip to main content
POST
Typed extraction (text, number, date, list, estimate, forecast)

Authorizations

Authorization
string
header
required

Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).

Body

application/json
model
enum<string>
required

Extraction model: clairic (64K context, text + images).

Available options:
clairic
fields
object
required

Map of field name → typed field spec; 1 to 256 fields. Answers come back under the same names. Fields that do not fit next to the state in one pass are split across parallel passes upstream.

state
string

The text to read and extract from. Text answers are character spans of this string. Required unless images is sent. Long text is truncated upstream to fit the model's context (truncated: true in the response).

images
any[]

Up to 4 embedded PNG / JPEG / WebP images placed before the state, as data: URLs or {content_type, base64} objects (4 MiB each, 8 MiB total decoded; remote URLs are not accepted). Each image bills at most 4,096 input tokens.

Maximum array length: 4
reference_date
string

ISO date that anchors dates written without a year.

Maximum string length: 40
options
object

Response

200

Default Response