Mailzero Assistant

Extract the fields you need from a message with your own schema

One model call on the message text (subject, sender, body) with a caller JSON schema of objects and primitives (up to 8 KB, no references): answers data in that shape, confidence (0 to 1) and evidence_quotes (verbatim excerpts). Cached by (message, schema, instructions) so the same question costs one call (cached: true after). Gated by the account's model budget (429 when spent, 503 when the model route is off). Sign-in code mails answer 403 AUTH_MESSAGE. Bodies over 60,000 characters answer 413.

post/api/emails/{address}/messages/{id}/extract

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/emails/{address}/messages/{id}/extract
  • Auth: HTTP bearer

Path parameters

addressstring required
idstring required

Message ID

Request body

schemaobject required

JSON schema of the fields to extract: an object of primitives, arrays and nested objects, under 8 KB, no $ref

instructionsstring

Optional guidance, e.g. amounts in EUR

Response

The extracted fields

message_idstring required
dataobject required
confidencenumber required
evidence_quotesstring[] required
modelstring required
cachedboolean required
generated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.